Skip to content

chore: update OpenAPI schema - #264

Merged
Him188 merged 1 commit into
mainfrom
chore/update-openapi-schema
Oct 17, 2026
Merged

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

Conversation

@fishaudio-bot

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

Copy link
Copy Markdown
Collaborator

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


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

Summary by CodeRabbit

  • New Features
    • Session reads and webhooks now include the end-user ID when provided.
    • You can filter agent sessions by an exact end-user ID.

@mintlify

mintlify Bot commented Oct 17, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated
hanabiaiinc 🟢 Ready View Preview Oct 17, 2026, 7:32 AM

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

@coderabbitai

coderabbitai Bot commented Oct 17, 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: dde178f3-f13c-43e6-8df6-f71b3a2c9821
📥 Commits

Reviewing files that changed from the base of the PR and between 2b0409a and e32632b.

📒 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

The OpenAPI reference adds end_user_id to agent session creation documentation, session-list filtering, and session response schemas. The session-list pagination wording is reformatted without changing its stated behavior.

Changes: Agent session end-user ID contract

Layer / File(s) Summary
Session end-user ID API contract
api-reference/openapi.json
The creation payload documentation states that end_user_id is stored verbatim, returned in session reads and webhooks, and filterable. The session list adds an optional nullable exact-match query parameter. Session detail and summary schemas add a nullable end_user_id field.

Priority: ➖ Normal

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

Change: Other

Suggested reviewers: him188

Merge Risk: ⚪ Minimal · up to e3263

This documents end-user IDs for session creation, exact-match filtering, and reads, consistent with existing session guidance. No concrete merge-blocking risk is evident.

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 accurately and concisely describes the primary change: updating the OpenAPI schema with new agent-session end-user filtering and response fields.
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.
Full details: Docstring Coverage

Explanation

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

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.

@Him188
Him188 merged commit 32c884f into main Oct 17, 2026
6 checks passed
@Him188
Him188 deleted the chore/update-openapi-schema branch October 17, 2026 07:35

This branch was successfully deployed

1 active deployment
staging — e32632b4 Deployed Oct 17, 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