Skip to content

fix(api): erroneous setting nesting in MetadataSettings #2964

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
6ixfalls wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

fix(api): erroneous setting nesting in MetadataSettings #2964

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 8 additions & 11 deletions seerr-api.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -522,17 +522,14 @@ components:
MetadataSettings:
type: object
properties:
settings:
type: object
properties:
tv:
type: string
enum: [tvdb, tmdb]
example: 'tvdb'
anime:
type: string
enum: [tvdb, tmdb]
example: 'tvdb'
tv:
type: string
enum: [tvdb, tmdb]
example: 'tvdb'
anime:
type: string
enum: [tvdb, tmdb]
example: 'tvdb'
Comment on lines 523 to +532
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Apr 28, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Mark tv and anime as required to match the actual API contract.

At Line 523, MetadataSettings defines properties but not required, so the schema allows empty/partial objects. That conflicts with MetadataSettings usage in server/lib/settings/index.ts:116-119 and the settings route expecting direct tv/anime fields.

📌 Proposed OpenAPI fix 
     MetadataSettings:
       type: object
       properties:
         tv:
           type: string
           enum: [tvdb, tmdb]
           example: 'tvdb'
         anime:
           type: string
           enum: [tvdb, tmdb]
           example: 'tvdb'
+      required:
+        - tv
+        - anime
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
type: object
properties:
settings:
type: object
properties:
tv:
type: string
enum: [tvdb, tmdb]
example: 'tvdb'
anime:
type: string
enum: [tvdb, tmdb]
example: 'tvdb'
tv:
type: string
enum: [tvdb, tmdb]
example: 'tvdb'
anime:
type: string
enum: [tvdb, tmdb]
example: 'tvdb'
type: object
properties:
tv:
type: string
enum: [tvdb, tmdb]
example: 'tvdb'
anime:
type: string
enum: [tvdb, tmdb]
example: 'tvdb'
required:
- tv
- anime
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@seerr-api.yml` around lines 523 - 532, The OpenAPI schema for
MetadataSettings is missing a required list for the tv and anime properties;
update the MetadataSettings object schema to include "required": ["tv","anime"]
so the tv and anime string enums are enforced and match the runtime expectations
in server/lib/settings/index.ts (where MetadataSettings is read at lines
handling the settings route) and any validation that expects direct tv/anime
fields.

Copy link
Copy Markdown
Member

@M0NsTeRRR M0NsTeRRR May 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you fix it @6ixfalls

This comment was marked as spam.

Sign in to view

TautulliSettings:
type: object
properties:
Expand Down
Loading