chore: update OpenAPI schema

[fishaudio-bot]

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

Summary by CodeRabbit

• Documentation
  • Updated the API reference with fields for content purge timestamps and warm-transfer ring and confirmation timeouts.
  • Documented a 410 response for permanently removed URIs, including status, message, and optional reason details.
  • Added pronunciation dictionary IDs to voice configuration schemas, with a limit of three IDs for updates.
  • Clarified that custom SIP headers follow and are merged with the number’s termination-header rules.

[coderabbitai]

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

• Configuration used: defaults
• Review profile: CHILL
• Plan: Advanced
• Run ID: ac6c45f5-e9c0-467b-b8cd-7cc2da33bd0d

📥 Commits

Reviewing files that changed from the base of the PR and between 1faa2a5 and e864898.

📒 Files selected for processing (1)

• api-reference/openapi.json

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

---

📝 Walkthrough

Walkthrough

The OpenAPI document adds content-purge fields and a 410 response schema. It also adds warm-transfer timeout and pronunciation dictionary fields, and revises the SIP-header description.

Changes

OpenAPI contract updates

Layer / File(s)	Summary
Content purge fields and 410 response api-reference/openapi.json	Two schemas gain nullable content_purged_at fields with a null default. The 410 response requires integer status and string message, and includes nullable reason with a null default.
Voice configuration fields api-reference/openapi.json	Voice schemas add warm-transfer ring and confirmation timeout fields with defaults of 30 and 60 seconds. They also add pronunciation_dictionary_ids; the patch schema allows null and limits the array to three items.
SIP-header description api-reference/openapi.json	The description removes the former header-name and printable-ASCII constraints. It now refers to the number’s termination_headers rules and says custom headers are merged over them.

Priority: ⬇️ Low

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

Change: Other

Suggested reviewers: him188

Merge Risk: ⚪ Minimal · up to e8648

No concrete contract issue remains; the OpenAPI update is mergeable after normal checks.

Architecture Summary

Architecture risk: 🔵 Low · up to e8648

The change affects 1 system.

Changed systems: api-reference

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

• observed — api-reference (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

• observed — Modified behavior in api-reference/openapi.json: Adds a nullable content_purged_at property with a null default.
• observed — Modified behavior in api-reference/openapi.json: Adds a 410 response for permanently removed URIs. Its JSON object requires integer status and string message; nullable reason defaults to null.
• observed — Modified behavior in api-reference/openapi.json: Adds integer warm-transfer ring and confirmation timeout properties, defaulting to 30 and 60 seconds respectively.
• observed — Modified behavior in api-reference/openapi.json: Adds pronunciation_dictionary_ids to PublicAgentVoicePatch as a nullable array of strings with at most three items and a null default.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly summarizes the main change: an update to the OpenAPI schema.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Commit to this branch
• Create a new PR

• Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Autopilot is currently an internal CodeRabbit preview.

---

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

[mintlify]

Preview deployment for your docs. Learn more about Mintlify Previews.

Project	Status	Preview	Updated
hanabiaiinc	🟢 Ready	View Preview	Oct 3, 2026, 3:13 AM

💡 Tip: Enable Automations to automatically generate PRs for you.