Skip to content

chore: update OpenAPI schema#84

Closed
fishaudio-bot wants to merge 1 commit into
mainfrom
chore/update-openapi-schema
Closed

chore: update OpenAPI schema#84
fishaudio-bot wants to merge 1 commit into
mainfrom
chore/update-openapi-schema

Conversation

@fishaudio-bot

@fishaudio-bot fishaudio-bot commented Jun 8, 2026

Copy link
Copy Markdown
Collaborator

Auto-generated update from https://api.fish.audio/openapi.json

Summary by CodeRabbit

  • New Features
    • Added source field to Model API responses, allowing clients to identify the source of each model in POST and GET endpoints.

@coderabbitai

coderabbitai Bot commented Jun 8, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 59b1ca85-92d8-4ca3-b237-04d4578114dc

📥 Commits

Reviewing files that changed from the base of the PR and between 9184a08 and 9e326ed.

📒 Files selected for processing (1)
  • api-reference/openapi.json

📝 Walkthrough

Walkthrough

This PR updates the OpenAPI specification to add a new source field to the Model schema. The field is defined as nullable (string or null) with a default value of null, and is consistently added to the central ModelEntity schema definition and all corresponding model response payloads.

Changes

Model source field in API schema

Layer / File(s) Summary
Add source field to Model schema definition and response payloads
api-reference/openapi.json
The source property (anyOf: [string, null], default: null) is added to components.schemas.ModelEntity and propagated to POST /model 201 and GET /model/{id} 200 response schemas.

Possibly related PRs

  • fishaudio/docs#75: Also modifies components.schemas.ModelEntity and model response schemas in the OpenAPI spec to adjust Model API contract definitions.
  • fishaudio/docs#72: Adds workflow and validation scripts for the OpenAPI specification that would enforce consistency with schema changes like the new source field.

Poem

🐰 A source appears in the schema's light,
Where Model now declares its birthright,
Null or string, the field takes flight,
Three schemas dance, aligned just right!


🎯 1 (Trivial) | ⏱️ ~5 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'chore: update OpenAPI schema' is vague and generic, using non-descriptive language that doesn't convey the specific change being made (adding a source field to Model responses). Consider using a more specific title like 'chore: add source field to Model schema in OpenAPI spec' to better communicate the actual change to reviewers.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/update-openapi-schema

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant