Document Overseerr issue management features#42494
Document Overseerr issue management features#42494c0ffeeca7 merged 4 commits intohome-assistant:nextfrom
Conversation
home-assistant
Bot
added
current
|
It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases. Documentation that needs to be updated for an upcoming release should target the |
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
AmGarera
requested review from
a team,
Danielhiversen,
Quentame,
allenporter,
bachya,
bdraco,
cgtobi,
dgomes,
elupus,
fabaff,
frenck,
gjohansson-ST,
hunterjm,
jjlawren,
jpbede,
mib1185,
raman325,
rohankapoorcom,
rytilahti,
synesthesiam and
uvjustin
as code owners
AmGarera
requested review from
Shulyaka,
TomBrien,
arturpragacz,
cdce8p,
chemelli74,
davet2001,
dmulcahey,
edenhaus and
karwosts
as code owners
home-assistant
Bot
removed
needs-rebase
|
Thank you for contributing, @AmGarera 👍
|
|
I'm drafting this PR, as changes are needed. Please undraft it once the changes have been implemented and the PR is ready for review again. |
Add documentation for new issue management features: - 6 new issue sensors (total, open, closed, video, audio, subtitle) - 4 new issue services (get_issues, create_issue, update_issue, delete_issue) - Example automations for automatic issue creation and monitoring - Updated use cases section
|
Thank you for the feedback! The PR should now be clean with only the Overseerr documentation changes. |
| | `sort_order` | Yes | The sort order to sort the results in (`added`/`modified`). | | ||
| | `requested_by` | Yes | Filter the requests based on the user ID of the requester. | | ||
|
|
||
| ### Action `overseerr.get_issues` |
There was a problem hiding this comment.
For the actions documentation, please apply the style that is suggested here:
https://github.com/home-assistant/home-assistant.io/blob/current/source/_integrations/_integration_docs_template.markdown?plain=1#L139
- Use a non-YAML title, mentioning the YAML in the introduction of the action description.
- Use a list instead of a table, as shown in the example.
There was a problem hiding this comment.
Should be all resolved now
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
- Changed action section titles to non-YAML format (e.g., 'Get requests' instead of 'Action overseerr.get_requests') - Mention the YAML action name in the introduction sentence - Replaced tables with list format for better readability - Format: **field_name** (*Required/Optional*): Description
| ### Issue actions | ||
|
|
||
| - `overseerr.get_issues` - Get a list of issues | ||
| - `overseerr.create_issue` - Create a new issue for media | ||
| - `overseerr.update_issue` - Update an existing issue | ||
| - `overseerr.delete_issue` - Delete an issue |
There was a problem hiding this comment.
Not yet, let's make this PR only about the new sensors
3 participants
Description
This PR documents the new issue management functionality for the Overseerr integration, including:
Related PRs
Notes
Documentation covers both the sensors (PR #158888) and services (upcoming PR) as they form a complete feature set. This PR should be merged after both implementation PRs are merged.