Skip to content

chore: update OpenAPI schema - #307

Merged
M2Night merged 1 commit into
mainfrom
chore/update-openapi-schema
Nov 3, 2026
Merged

M2Night merged 1 commit into
mainfrom
chore/update-openapi-schema

Conversation

@fishaudio-bot

@fishaudio-bot fishaudio-bot commented Nov 3, 2026 •

Copy link
Copy Markdown
Collaborator

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


Autofix with [code]smith
Open in [code]smith · Need help on this PR? Tag @codesmith-bot with what you need.

Summary by CodeRabbit

  • Documentation
    • Clarified how version hashes behave for previously published, unchanged, and superseded versions.

@mintlify

mintlify Bot commented Nov 3, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated
hanabiaiinc 🟢 Ready View Preview Nov 3, 2026, 8:06 AM

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

@coderabbitai

coderabbitai Bot commented Nov 3, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review.

Walkthrough

The GET /v1/agent/agents/{agent_id}/versions description now clarifies hash handling for older versions, unchanged publishes, and superseded versions.

Changes: Agent version hash documentation

Layer / File(s) Summary
Version history description
api-reference/openapi.json
The API reference clarifies that older and superseded versions keep frozen hashes, and an unchanged publish realigns the live version’s hash without creating an identical version.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Possibly related PRs

  • fishaudio/docs#305: Documents publish and draft hash contracts and version snapshot timing, which are related to the version hash behavior clarified here.

Suggested reviewers: him188

Merge Risk: Minimal · up to 485ad

The update clarifies version hash behavior without a reported API contract change. No actionable merge-blocking risk is identified.

Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title "chore: update OpenAPI schema" describes the change type and target file. The PR updates api-reference/openapi.json with an auto-generated sync from the upstream OpenAPI spec. The title is a…
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
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.
Full details: Title check

Explanation

The title "chore: update OpenAPI schema" describes the change type and target file. The PR updates api-reference/openapi.json with an auto-generated sync from the upstream OpenAPI spec. The title is accurate but does not name the specific change, which is a clarified hash-behavior description for GET /v1/agent/agents/{agent_id}/versions. This is a partial match: it refers to the real change but not its substance. It is not vague or generic, so the check passes.

Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Finishing Touches
Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Warning

Some tools did not complete. Review the errors below.

ast-grep (0.51.1)

ast-grep could not parse rule config: /ast-grep-rules/ast-grep-essentials/rules/javascript/security/express-session-hardcoded-secret-javascript.yml

Tip

🎯 Customize your risk assessments

Guide how CodeRabbit assesses merge risk and security architecture risk. Highlight sensitive changes and explain your security boundaries using Merge Risk Instructions and Security Risk Instructions in your review settings. Security architecture risk assessments require the Advanced plan or above.

✅ Automatic approvals, with your rules

Let CodeRabbit approve pull requests once required threads are resolved, pre-merge checks pass, and your risk limits are met. Enable Automatic approvals in review settings, with overrides for teams or file paths.

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

CodeRabbit Verify

  • Run CodeRabbit Verify to test the changes in this pull request.
Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 9831405e-8707-4ff3-b79e-c8812e3020ab
Commits

Reviewing files that changed from the base of the PR and between d431dba and 485ad43.

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.

@M2Night
M2Night merged commit 88dc898 into main Nov 3, 2026
6 checks passed
@M2Night
M2Night deleted the chore/update-openapi-schema branch November 3, 2026 08:11

This branch was successfully deployed

1 active deployment
staging — 485ad43a Deployed Nov 3, 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.

2 participants