Repository navigation
docs: cover Ombi, the Services section and the watch statistics API - #178
Merged
Merged
Conversation
The drift report for the next release (#177) lists Ombi as a second request service, a settings navigation rework, per-server exclusion tagging, a new media-server sort field and three new endpoints. Ombi gets a Configuration section, because the settings page's docs button links to Configuration/#ombi and that anchor did not exist. Its seven rule properties are in the glossary with the quirks a reader cannot infer from the names: Ombi stamps an approval only when someone approves by hand, holds one request per movie and one per user for a show, and stores air dates only for the episodes someone requested. The "Force delete Ombi request" toggle is described next to the Seerr one, including what a season removal leaves in place, since Ombi can only delete a whole request. Service connections moved out of Settings into their own Services section, so the Settings -> X references now say Services -> X. The Radarr and Sonarr field tables still described a hostname, port and base URL form that the card layout replaced, and the exclusion tag is set per server rather than per service, so both were rewritten against the current form. The API reference gains an Ombi page and a watch statistics page for the Tautulli and Tracearr per-item endpoints. A new page has no route into the site without a sidebars.js entry, which is the only edit outside docs/ and static/openapi-spec/.
The doc-only rule for drift PRs forbids touching sidebars, which reads as forbidding the one edit a new page under docs/api/ cannot do without: a page with no sidebars.js entry has no route into the site. Spell out the exception so the next drift PR does not have to weigh it again, and keep the requirement to call it out in the PR description.
This was referenced Oct 1, 2026
enoch85
added a commit
that referenced
this pull request
Oct 3, 2026
The drift report for #180 now spans v3.30.0 to HEAD. The 3.30.0 snapshot was cut before this branch merged, so the Next docs still lack the fixes #178 did not reach, and this carries them alongside the four fixes since. Several API pages described behaviour the fixes reversed. The Streamystats test said it never sends the stored Jellyfin key, and it now does. Posting an empty TVDB key was documented as wiping the stored key, and it is now refused. Four read routes answered a failed database read with 200 and now answer 500. The logs route ignored DATA_DIR and now follows it. The font upload had no size limit and is now capped at 32 MB. Each of those is corrected in place rather than annotated. Rules.mdx said a renamed rule group leaves its old *arr tag behind. The save now moves it, and same-named groups keep a shared tag while any of them holds the item. The Sonarr episode actions gain two sentences on the TVDB episode id match and on multi-episode files, since both change which episode or file an action touches. The Seerr requester route takes a required type, so the OpenAPI spec gets that parameter under all three aliases. Since 3.30.0, Force reset Seerr record keeps a season request that still covers another season, because Seerr cannot take one season out of a request; Rules.mdx says so next to the matching Ombi sentence. A media server switch that deletes a section's first rule now keeps that section's AND/OR join, which MediaServerSwitching.md lists with the other migration outcomes. The other fixes in range make the code match what the docs already say, so they are left alone.
enoch85
added a commit
that referenced
this pull request
Oct 3, 2026
) The drift report for #180 now spans v3.30.0 to HEAD. The 3.30.0 snapshot was cut before this branch merged, so the Next docs still lack the fixes #178 did not reach, and this carries them alongside the four fixes since. Several API pages described behaviour the fixes reversed. The Streamystats test said it never sends the stored Jellyfin key, and it now does. Posting an empty TVDB key was documented as wiping the stored key, and it is now refused. Four read routes answered a failed database read with 200 and now answer 500. The logs route ignored DATA_DIR and now follows it. The font upload had no size limit and is now capped at 32 MB. Each of those is corrected in place rather than annotated. Rules.mdx said a renamed rule group leaves its old *arr tag behind. The save now moves it, and same-named groups keep a shared tag while any of them holds the item. The Sonarr episode actions gain two sentences on the TVDB episode id match and on multi-episode files, since both change which episode or file an action touches. The Seerr requester route takes a required type, so the OpenAPI spec gets that parameter under all three aliases. Since 3.30.0, Force reset Seerr record keeps a season request that still covers another season, because Seerr cannot take one season out of a request; Rules.mdx says so next to the matching Ombi sentence. A media server switch that deletes a section's first rule now keeps that section's AND/OR join, which MediaServerSwitching.md lists with the other migration outcomes. The other fixes in range make the code match what the docs already say, so they are left alone.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Covers the
v3.29.0->HEADdrift reported in #177.What was added
Configuration.mdOmbisection. The service page's docs button links toConfiguration/#ombi, and that anchor did not existConfiguration.mdServices; theSettings -> Xreferences sayServices -> XConfiguration.mdServer Name,URL,Base Path,API key, one card per instance. TheHostname or IP/Port/Base URLtable and its leading-slash note described a form that no longer existsConfiguration.mdGlossary.mdOmbisection, all seven properties, with the auto-approval and per-episode air-date behaviourRules.mdxForce delete Ombi requestrow, which rule types show it, and what a season removal keepsNotifications.mdrequestedBycarries bothCollections.mdDate Addedin the collection items sort listOverlays.mdMigration.mdforceOmbifield, and the exclusion-tag move onto each *arr server rowSecurity.mdapi/settings.md/api/settings/ombiroutesapi/ombi.md(new)GET /api/ombi/requests/{tmdbId}/usersapi/watch-statistics.md(new)GET /api/tautulli/items/{itemId}andGET /api/tracearr/items/{itemId}, and the 200/404/502 contract they shareAPI.md,openapi-specThe two new API pages need two lines in
sidebars.js: a page has no route into the site without one.AGENTS.mdforbids touching sidebars, which reads as forbidding exactly that, so this also adds the exception to that rule. Those two are the only edits outsidedocs/andstatic/openapi-spec/.Already covered by prior PRs
Tag this contentremoving the tag when an item leaves the collection. #3781 fixed the leave paths that missed it; the documented behaviour was already the intended oneDeliberately not documented
npm run formatandnpm run buildboth pass, with no broken link or anchor warnings.One drive-by in the same Security line: it said "qBittorrent download-client password" and now says "download-client password", since Transmission is supported too.