Skip to content

chore: update OpenAPI schema #89

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

Merged
Kilerd merged 1 commit into from
Jun 17, 2026
Merged

chore: update OpenAPI schema #89

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
2 changes: 1 addition & 1 deletion api-reference/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4807,7 +4807,7 @@
"reference_text": {
"anyOf": [
{
"maxLength": 300,
"maxLength": 150,

@coderabbitai coderabbitai Bot Jun 17, 2026

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.

"type": "string"
},
{
Expand Down
Loading