Updated Overseerr docs to include information about Issues support #37368
Conversation
home-assistant
bot
added
has-parent
📝 WalkthroughWalkthroughThe changes expand the Overseerr integration by introducing a separate event entity for issues alongside the existing media events. The integration now supports additional issue events—reported, comment, resolved, and reopened—and incorporates new statistics metrics for issue tracking (e.g., total issues, audio, subtitle, video, other, and open issues). An updated automation example for issue notifications has also been added. The integration's data update mechanism now accommodates both media requests and issue-related data. Changes
Sequence Diagram(s)sequenceDiagram
participant Source as Event Source
participant Integration as Overseerr Integration
participant Stats as Statistics Updater
participant Automation as Automation Service
Source->>Integration: Emit event (media or issue)
alt Media Event
Integration->>Stats: Update media request stats
else Issue Event
Integration->>Stats: Update issue metrics
Integration->>Automation: Execute issue notification automation
end
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
source/_integrations/overseerr.markdown (5)
58-63: Document New Issue Events
The new list of issue events (‘reported’, ‘comment’, ‘resolved’, ‘reopened’) is clearly specified. Please double-check that the markdown list formatting (indentation and surrounding blank lines as per MD007/MD032) meets the documentation style guidelines.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
59-59: Unordered list indentation
Expected: 0; Actual: 1(MD007, ul-indent)
59-59: Lists should be surrounded by blank lines
null(MD032, blanks-around-lists)
60-60: Unordered list indentation
Expected: 0; Actual: 1(MD007, ul-indent)
61-61: Unordered list indentation
Expected: 0; Actual: 1(MD007, ul-indent)
62-62: Unordered list indentation
Expected: 0; Actual: 1(MD007, ul-indent)
64-64: Subject–Verb Agreement Suggestion
The sentence “Relevant data about the request are stored in the attributes.” might read more clearly as “Relevant data about the request is stored in the attributes.” (noting that “data” can be treated as singular in contemporary usage).-Relevant data about the request are stored in the attributes. +Relevant data about the request is stored in the attributes.🧰 Tools
🪛 LanguageTool
[uncategorized] ~64-~64: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...pened` Relevant data about the request are stored in the attributes. ### Sensors ...(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
77-82: Addition of Issue Sensor Metrics
The newly added sensor items (Total issues, Audio issues, Subtitle issues, Video issues, Other issues, Open issues) effectively complement the existing metrics. Please consider reviewing the list indentation and surrounding blank lines to conform with markdown style guidelines (MD007, MD032).🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
77-77: Unordered list indentation
Expected: 0; Actual: 1(MD007, ul-indent)
78-78: Unordered list indentation
Expected: 0; Actual: 1(MD007, ul-indent)
79-79: Unordered list indentation
Expected: 0; Actual: 1(MD007, ul-indent)
80-80: Unordered list indentation
Expected: 0; Actual: 1(MD007, ul-indent)
81-81: Unordered list indentation
Expected: 0; Actual: 1(MD007, ul-indent)
82-82: Unordered list indentation
Expected: 0; Actual: 1(MD007, ul-indent)
104-104: Refine Use Cases Wording
The sentence “The integration can be used to build automations to help and notify you of new media and issue requests” could be rephrased for clarity. A suggested revision is:-The integration can be used to build automations to help and notify you of new media and issue requests. +The integration can be used to build automations to notify you of new media and issue requests.🧰 Tools
🪛 LanguageTool
[grammar] ~104-~104: The word ‘help’ is a conjunction. In formal texts, use “to”.
Context: ...an be used to build automations to help and notify you of new media and issue reque...(HELP_AND_VB)
176-176: Hyphenate “up-to-date” in Data Updates Section
For proper adjective formatting, consider changing “up to date” to “up-to-date”. For example:-... make sure they are up to date. +... make sure they are up-to-date.🧰 Tools
🪛 LanguageTool
[uncategorized] ~176-~176: It appears that hyphens are missing in the adjective “up-to-date”.
Context: ...es the statistics to make sure they are up to date. In addition, the integration checks fo...(UP_TO_DATE_HYPHEN)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/overseerr.markdown(5 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/overseerr.markdown
[uncategorized] ~64-~64: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...pened` Relevant data about the request are stored in the attributes. ### Sensors ...
(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[grammar] ~104-~104: The word ‘help’ is a conjunction. In formal texts, use “to”.
Context: ...an be used to build automations to help and notify you of new media and issue reque...
(HELP_AND_VB)
[uncategorized] ~176-~176: It appears that hyphens are missing in the adjective “up-to-date”.
Context: ...es the statistics to make sure they are up to date. In addition, the integration checks fo...
(UP_TO_DATE_HYPHEN)
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/overseerr.markdown
51-51: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
51-51: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
52-52: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
53-53: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
54-54: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
55-55: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
56-56: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
59-59: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
59-59: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
60-60: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
61-61: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
62-62: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
77-77: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
78-78: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
79-79: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
80-80: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
81-81: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
82-82: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (4)
source/_integrations/overseerr.markdown (4)
48-50: Clarify the Dual Event Entity Concept
The updated text clearly introduces two distinct event entities (one for media, one for issues), which aligns with the enhanced integration capabilities.
68-68: Enhanced Sensor Description
The introduction now mentions that statistics are provided for both requests and issues, which is a clear and concise update.
113-137: Media Request Automation Example Looks Good
The YAML snippet for “Overseerr request push notification” is clear and consistent with the integration’s naming conventions. It provides a well-documented example for users.
140-169: New Issue Notification Automation Example
The newly added YAML example for “Send me a push notification on a new issue” is clear and consistent with the media requests example. Ensure that the trigger entity (event.overseerr_last_issue_event) and associated payload align with the integration’s design.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
source/_integrations/overseerr.markdown (2)
143-172: New Automation Example for Issue Push Notification
This new YAML example effectively demonstrates how to set up push notifications for issue events (using thereportedevent type). Consider adding a brief note or comment to suggest that users may adjust the condition if they want to handle other issue-related events (likecomment,resolved, orreopened) in the future.
179-179: Minor Typo in Data Update Description
The phrase "up-todate" appears in the description; it should be corrected to "up-to-date" for clarity and professionalism.Apply the following change:
-... it updates the statistics to make sure they are up-todate. +... it updates the statistics to make sure they are up-to-date.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/overseerr.markdown(4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (4)
source/_integrations/overseerr.markdown (4)
48-65: New Issue and Media Events List Updated
The added segment clearly delineates events for the media entity (e.g.,pending,approved, etc.) and the new issue entity (e.g.,reported,comment,resolved,reopened). This enhancement improves clarity on how event updates are categorized. Please ensure that these event names are consistently referenced throughout the integration code and any related documentation.
70-85: Addition of New Sensor Statistics for Issues
The updated sensors list now includes issue-related metrics alongside existing media request statistics. This comprehensive list (including sensors for Total issues, Audio issues, Subtitle issues, Video issues, Other issues, and Open issues) aligns well with the expanded feature set. Verify that these sensor names match the corresponding keys returned by Overseerr and adhere to your naming conventions.
107-107: Updated Use Cases with Issue Support
The revised use case now mentions that the integration can be used to build automations for both media and issue requests. This provides a clear indication of the broadened functionality.
117-138: Automation Example for Media Request Push Notification
The YAML example for media request notifications is clear and well-structured. It demonstrates the use of a state trigger onevent.overseerr_last_media_eventand a condition checking for thependingstatus. Ensure that users are aware of the expected attributes (such asevent_typeandsubject) returned by the event for a seamless experience.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
source/_integrations/overseerr.markdown (2)
48-66: Enhanced Event Entities Documentation
The updated section now clearly differentiates between media and issue events. The new description for issue events (“reported”, “comment”, “resolved”, “reopened”) is consistent with the PR objectives and provides clear guidance to users.
70-86: Comprehensive Sensor Metrics Section
The sensor list now includes metrics for both media requests and issues. While this comprehensive list meets the objective, consider grouping the sensors under distinct sub-headings (e.g., “Media Requests” and “Issue Metrics”) to improve clarity and readability.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/overseerr.markdown(3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (4)
source/_integrations/overseerr.markdown (4)
107-107: Updated Use Cases for Automation
The revised use case text now mentions automations for both media and issue requests, aligning perfectly with the new feature support. The phrasing is clear and sets the right context.
112-116: Media Request Automation Example Validation
The example for sending a push notification on a new media request (using thependingevent) is clear and adequately demonstrates how automations can be set up. It might be helpful to note explicitly that users are free to use other event types if needed.
145-176: Issue Notification Automation Example Added
The new automation example for issue notifications (triggered by thereportedevent) is a valuable addition. It clearly shows how to set up a notification for issue events. Please double-check the YAML formatting against Home Assistant’s documentation to ensure full compliance.
183-183: Updated Data Update Description
The data update section now explicitly states that both requests and issue updates are handled, which improves transparency regarding the integration’s behavior. This change is clear and aligned with the new functionality.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
source/_integrations/overseerr.markdown (1)
150-181: New Automation Example for Issue Notifications:
The newly added automation example for push notifications on issue events is well-structured and mirrors the existing example for media requests. By checking for thereportedevent type, the example clearly demonstrates how users can set up notifications for new issue events.Consider adding a brief inline note within the YAML (or as a comment above the code block) to inform users that they can adjust the condition to handle other issue event types if needed.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/overseerr.markdown(3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (4)
source/_integrations/overseerr.markdown (4)
48-67: Clear Update of Event Entities:
The changes clearly introduce a separation between media and issue events. The documentation now lists the six media event types along with the four new issue event types (reported,comment,resolved, andreopened). This update is consistent with the new feature support.
70-90: Enhanced Sensor Metrics Section:
The sensor section has been updated to include statistics for both requests and issues. The lists under "#### Requests" and "#### Issues" now provide a comprehensive overview, reflecting the added issue tracking functionality. Ensure that these sensor identifiers and descriptions are in sync with the corresponding integration code.
112-114: Updated Use Cases to Include Issue Tracking:
The modifications in the use cases section now mention that the integration can be used to build automations for both media and issue requests. This change effectively communicates the broader functionality of the Overseerr integration.
188-190: Data Update Mechanism Clarification:
The updated description now explicitly mentions that, upon receiving updates, the integration refreshes statistics for both requests and issues. This clarification ensures that documentation aligns with the new dual-update functionality.
Proposed change
Brings the documentation inline with adding Issue support
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit