chore: update OpenAPI schema#89
Conversation
📝 WalkthroughWalkthroughThe ChangesVoiceDesignRequest Schema Constraint
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
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
📒 Files selected for processing (1)
api-reference/openapi.json
| "anyOf": [ | ||
| { | ||
| "maxLength": 300, | ||
| "maxLength": 150, |
There was a problem hiding this comment.
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.
Auto-generated update from https://api.fish.audio/openapi.json
Summary by CodeRabbit