chore: update OpenAPI schema

[fishaudio-bot]

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

[coderabbitai]

Warning

Review limit reached

@fishaudio-bot, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 58 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 24eb03b5-00cf-401c-85f8-bda6dfbd7697

📥 Commits

Reviewing files that changed from the base of the PR and between ae53e63 and 41472f5.

📒 Files selected for processing (1)

• api-reference/openapi.json

📝 Walkthrough

Walkthrough

The OpenAPI specification adds PVC lifecycle fields to model schemas, updates GET /model query parameter descriptions, and removes documented 422 validation-error responses from wallet, model, TTS, ASR, and voice-design endpoints.

Changes

OpenAPI schema and response documentation

Layer / File(s)	Summary
Model PVC schema fields api-reference/openapi.json	Adds nullable release and retirement fields to POST /model, GET /model/{id}, and components.schemas.ModelEntity.
Model query descriptions api-reference/openapi.json	Updates the self and author_id query parameter descriptions for GET /model.
Validation response definitions api-reference/openapi.json	Removes documented 422 response entries from wallet, model, TTS, timestamped TTS streaming, ASR, and voice-design endpoints.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

• fishaudio/docs#74: Modifies the GET /model success response schema.
• fishaudio/docs#75: Modifies the shared ModelEntity and related model response schemas.
• fishaudio/docs#95: Modifies the GET /model/{id} operation responses.

Suggested reviewers: cshape, kilerd

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
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.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main change: updating the OpenAPI schema.

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

api-reference/openapi.json (1)

237-237: 🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win

Restore the documented validation-error contract.

The SDK documentation at .mintlify/skills/fish-audio-sdk/references/errors.md:45-96 says invalid input still returns HTTP 422. Removing these responses makes the API reference and generated clients omit a real error path.

• api-reference/openapi.json#L237-L237: restore the 422 response for GET /wallet/{user_id}/package.
• api-reference/openapi.json#L386-L386: restore the 422 response for GET /wallet/{user_id}/api-credit.
• api-reference/openapi.json#L611-L611: restore the 422 response for GET /model.
• api-reference/openapi.json#L1451-L1451: restore the 422 response for POST /model.
• api-reference/openapi.json#L1790-L1790: restore the 422 response for GET /model/{id}.
• api-reference/openapi.json#L2150-L2150: restore the 422 response for PATCH /model/{id}.
• api-reference/openapi.json#L2205-L2205: restore the 422 response for DELETE /model/{id}.
• api-reference/openapi.json#L2316-L2316: restore the 422 response for POST /v1/tts.
• api-reference/openapi.json#L3219-L3219: restore the 422 response for POST /v1/tts/stream/with-timestamp.
• api-reference/openapi.json#L3400-L3400: restore the 422 response for POST /v1/asr.
• api-reference/openapi.json#L3514-L3514: restore the 422 response for POST /v1/voice-design.

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@api-reference/openapi.json` at line 237, Restore the documented HTTP 422
validation response in api-reference/openapi.json for GET
/wallet/{user_id}/package (237-237), GET /wallet/{user_id}/api-credit (386-386),
GET /model (611-611), POST /model (1451-1451), GET /model/{id} (1790-1790),
PATCH /model/{id} (2150-2150), DELETE /model/{id} (2205-2205), POST /v1/tts
(2316-2316), POST /v1/tts/stream/with-timestamp (3219-3219), POST /v1/asr
(3400-3400), and POST /v1/voice-design (3514-3514), preserving the existing
documented 422 response schema and description so generated clients retain this
error path.

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Outside diff comments:
In `@api-reference/openapi.json`:
- Line 237: Restore the documented HTTP 422 validation response in
api-reference/openapi.json for GET /wallet/{user_id}/package (237-237), GET
/wallet/{user_id}/api-credit (386-386), GET /model (611-611), POST /model
(1451-1451), GET /model/{id} (1790-1790), PATCH /model/{id} (2150-2150), DELETE
/model/{id} (2205-2205), POST /v1/tts (2316-2316), POST
/v1/tts/stream/with-timestamp (3219-3219), POST /v1/asr (3400-3400), and POST
/v1/voice-design (3514-3514), preserving the existing documented 422 response
schema and description so generated clients retain this error path.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 0efba3fd-1352-4aee-9d9c-c89e0007d9f9

📥 Commits

Reviewing files that changed from the base of the PR and between 5bbf5b7 and ae53e63.

📒 Files selected for processing (1)

• api-reference/openapi.json