Add Transmission get_torrents service and codeowner #42600
Conversation
home-assistant
bot
added
has-parent
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
This PR adds documentation for a new get_torrents action in the Transmission integration and adds the author as a code owner. The changes support the parent pull request that implements this new service in Home Assistant core.
Key changes:
- Documents the new
get_torrentsaction with parameters and usage example - Adds
@andrew-codechimpas a code owner for the Transmission integration
| | `entry_id` | no | The integration entry_id | | ||
| | `id` | no | ID of the torrent, can be found in the `torrent_info` attribute of the `*_torrents` sensors | | ||
|
|
||
| ### Action `get_torrents` |
There was a problem hiding this comment.
| ### Action `get_torrents` | |
| ### Action: Get torrents |
|
|
||
| Gets torrent details for the selected filter. | ||
|
|
||
| This action populates [Response Data](/docs/scripts/perform-actions#use-templates-to-handle-response-data) with a dictionary of torrents based on the provided filter. |
There was a problem hiding this comment.
| This action populates [Response Data](/docs/scripts/perform-actions#use-templates-to-handle-response-data) with a dictionary of torrents based on the provided filter. | |
| The `get_torrents` action populates [Response Data](/docs/scripts/perform-actions#use-templates-to-handle-response-data) with a dictionary of torrents based on the provided filter. |
|
|
||
| This action populates [Response Data](/docs/scripts/perform-actions#use-templates-to-handle-response-data) with a dictionary of torrents based on the provided filter. | ||
|
|
||
| | Data attribute | Optional | Description | |
There was a problem hiding this comment.
I know this is the style that is used in the rest of the document, and what you are doing is consistent with the rest..
But we are trying to move towards the style used in this example here:
https://github.com/home-assistant/home-assistant.io/blob/current/source/_integrations/_integration_docs_template.markdown?plain=1#L139
- the title uses the UI string, not the YAML. the YAML is then used in the intro.
- The descriptive content is not in a table but uses a list instead.
There was a problem hiding this comment.
That's so much better than tables, thanks for the pointer.
I've moved all actions to this style.
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
c0ffeeca7
left a comment
c0ffeeca7
left a comment
There was a problem hiding this comment.
Thank you, @andrew-codechimp 👍
2 participants
Proposed change
Add documentation for new action get_torrents
Add myself as a codeowner
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.