Skip to content

chore: update OpenAPI schema - #234

Closed
fishaudio-bot wants to merge 0 commit into
mainfrom
chore/update-openapi-schema
Closed

fishaudio-bot wants to merge 0 commit into
mainfrom
chore/update-openapi-schema

Conversation

@fishaudio-bot

@fishaudio-bot fishaudio-bot commented Oct 8, 2026 •

Copy link
Copy Markdown
Collaborator

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

@mintlify

mintlify Bot commented Oct 8, 2026 •

Copy link
Copy Markdown

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

Project Status Preview Updated
hanabiaiinc 🟢 Ready View Preview Oct 8, 2026, 6:57 AM

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

@coderabbitai

coderabbitai Bot commented Oct 8, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 7e339217-56be-46ed-9590-7741d389a18d
📥 Commits

Reviewing files that changed from the base of the PR and between 19dbb09 and 523a38d.

📒 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 contract adds agent variable configuration to patch, draft, and published configuration representations. Defaults accept string, integer, number, or boolean values. The schema descriptions specify how session values and unresolved placeholders are handled.

Changes

Agent variable configuration

Layer / File(s) Summary
Variable configuration contracts
api-reference/openapi.json
PublicAgentConfigPatchPayload adds nullable variables. New schemas define the patch and configuration shapes, including supported default value types. Their descriptions specify that session values take precedence and unresolved placeholders render as empty text. The patch description states that the defaults map replaces as a whole.
Draft and published configuration fields
api-reference/openapi.json
Draft-config responses and the published configuration schema add variables, referencing AgentVariablesConfig.

Priority: ⬇️ Low

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

Change: Other

Suggested reviewers: him188

Merge Risk: ⚪ Minimal · up to 523a3

This updates the API reference to document agent variable defaults. It is additive and backward-compatible, and no merge-blocking risk was found.

🚥 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. 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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: updating the OpenAPI schema with agent variable configuration fields.
✨ 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

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.

@fishaudio-bot
fishaudio-bot force-pushed the chore/update-openapi-schema branch from 523a38d to 62668a0 Compare October 8, 2026 06:57
@fishaudio-bot
fishaudio-bot force-pushed the chore/update-openapi-schema branch from 62668a0 to 53eed2b Compare October 9, 2026 03:06
@fishaudio-bot
fishaudio-bot deleted the chore/update-openapi-schema branch October 9, 2026 03:06

This branch was successfully deployed

1 active (outdated) deployment
staging — 62668a04 Deployed Oct 8, 2026 by mintlify[bot]
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.

1 participant