Skip to content

chore: update OpenAPI schema - #212

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 Sep 29, 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. Autofix is disabled.

Summary by CodeRabbit

  • New Features
    • Agent session details now include the participant identity, the agent’s participant identity, and when the agent joined. These fields may be null.

@coderabbitai

coderabbitai Bot commented Sep 29, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

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: 1592d4d7-4884-4d72-8c63-ade588336260

📥 Commits

Reviewing files that changed from the base of the PR and between 62656ef and 4bb3c4f.

📒 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 AgentSessionSummary schema and the GET /v1/agent/sessions/{session_id} response now include three nullable, default-null string fields: participant_identity, agent_participant_identity, and agent_joined_at.

Changes

Agent session fields

Layer / File(s) Summary
Session response contract
api-reference/openapi.json
The AgentSessionSummary schema and session detail response add the same three nullable, default-null string fields.

Priority: ⬇️ Low

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

Change: Feature

Suggested reviewers: him188

Merge Risk: ⚪ Minimal · up to 4bb3c

This update extends the agent session response with optional participant identity and agent join-time fields. Existing consumers should be unaffected because the fields are nullable and default to null. Merge risk is minimal.

Architecture Summary

Architecture risk: 🔵 Low · up to 4bb3c

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: The GET /v1/agent/sessions/{session_id} response schema adds nullable, default-null string fields for participant identity, agent participant identity, and agent join time.
  • observed — Modified behavior in api-reference/openapi.json: AgentSessionSummary adds the same three nullable, default-null string fields for participant identity, agent participant identity, and agent join time.
🚥 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 and concisely describes the main change: updating 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

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.

@mintlify

mintlify Bot commented Sep 29, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated
hanabiaiinc 🟢 Ready View Preview Sep 29, 2026, 3:02 AM

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

@fishaudio-bot
fishaudio-bot force-pushed the chore/update-openapi-schema branch from 4bb3c4f to 1c86e66 Compare September 29, 2026 16:11
@fishaudio-bot
fishaudio-bot deleted the chore/update-openapi-schema branch September 29, 2026 16:11

This branch was successfully deployed

1 active deployment
staging — 1c86e66f Deployed Sep 29, 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