Skip to content

chore: update OpenAPI schema#89

Merged
Kilerd merged 1 commit into
mainfrom
chore/update-openapi-schema
Jun 17, 2026
Merged

chore: update OpenAPI schema#89
Kilerd merged 1 commit into
mainfrom
chore/update-openapi-schema

Conversation

@fishaudio-bot

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

Copy link
Copy Markdown
Collaborator

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

Summary by CodeRabbit

  • Breaking Changes
    • The maximum character limit for reference text input has been reduced from 300 to 150 characters. Please review any existing submissions that exceed this new limit.

@coderabbitai

coderabbitai Bot commented Jun 17, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The maxLength constraint on VoiceDesignRequest.reference_text in api-reference/openapi.json is reduced from 300 to 150. This is a single-line change tightening the validation limit for that field.

Changes

VoiceDesignRequest Schema Constraint

Layer / File(s) Summary
reference_text maxLength reduction
api-reference/openapi.json
VoiceDesignRequest.reference_text.maxLength changed from 300 to 150.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • fishaudio/docs#73: Modifies api-reference/openapi.json schema definitions in the same OpenAPI document.
  • fishaudio/docs#76: Makes targeted edits to api-reference/openapi.json OpenAPI schema constraints, same file and schema area.

Poem

🐇 Snip, snip, snip — the text grows lean,
Three hundred chars? Too wide a scene!
One-fifty now, a tighter bound,
The reference_text stays neatly round.
Less is more, the rabbit found! ✂️

🚥 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. While it mentions OpenAPI schema, it doesn't convey the specific, meaningful change: tightening the maxLength constraint on VoiceDesignRequest.reference_text from 300 to 150 characters. Consider a more specific title like 'chore: reduce VoiceDesignRequest reference_text max length to 150' to better communicate the actual schema constraint change.
✅ 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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 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.

Inline comments:
In `@api-reference/openapi.json`:
- Line 4810: The maxLength constraint for VoiceDesignRequest.reference_text has
been updated to 150 characters in the OpenAPI schema, but the documentation
files still reference the old 300-character limit. Update the documentation in
api-reference/endpoint/openapi-v1/voice-design.mdx (around lines 44-49) and
features/voice-design.mdx (around lines 128-146) to change all references to
reference_text character limits from 300 characters to 150 characters to align
with the new API contract.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 9c953c48-62a3-4db2-bde8-3af6839ec6f8

📥 Commits

Reviewing files that changed from the base of the PR and between 538c9ca and 376778d.

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

"anyOf": [
{
"maxLength": 300,
"maxLength": 150,

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Update downstream docs to match the new 150-character contract.

VoiceDesignRequest.reference_text now enforces maxLength: 150, but the provided docs context still says “up to 300 characters” in api-reference/endpoint/openapi-v1/voice-design.mdx (Line 44-49) and features/voice-design.mdx (Line 128-146). This contract drift will cause avoidable 422s for users following the docs.

🤖 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 4810, The maxLength constraint for
VoiceDesignRequest.reference_text has been updated to 150 characters in the
OpenAPI schema, but the documentation files still reference the old
300-character limit. Update the documentation in
api-reference/endpoint/openapi-v1/voice-design.mdx (around lines 44-49) and
features/voice-design.mdx (around lines 128-146) to change all references to
reference_text character limits from 300 characters to 150 characters to align
with the new API contract.

@Kilerd Kilerd merged commit 9a3a6e7 into main Jun 17, 2026
6 checks passed
@Kilerd Kilerd deleted the chore/update-openapi-schema branch June 17, 2026 06:58
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.

2 participants