docs(api): refresh AI SRE (safari) OpenAPI — adopt sessions, fix drift#97
Merged
Conversation
Regenerate the AI SRE (safari) OpenAPI spec from the Go source of truth (fc-safari@feat/ai-sre handlers + types; fc-pgy@feat/ai-sre registry). Scope is now 4 sub-modules / 27 public (auth=all) ops: - Skills (8), MCP servers (7), A2A agents (7) - Sessions (5): get, list, export, delete + deprecated cancel Highlights: - Adopt safari/session as a proper bilingual sub-module. Re-derive the request schemas and own the large response schemas (SessionItem, EventItem, …), translating the field descriptions that were previously English-only in the zh spec. - Fix real drift: SessionListRequest.app_name was missing the `swe` value. - Model session/export as an application/x-ndjson stream; delete -> null; cancel marked deprecated with an InterruptAck response. - Drop orphan ExportLine/ExportUsage schemas. - Reflect the new account rate limits on skill upload (3/s, 30/min) and download (5/s, 60/min) in the Restrictions tables (registry change in fc-pgy #568). Both per-module files (rendered by Mintlify) and the consolidated reference copies are updated. Validated: JSON loads, no dangling/orphan $refs, en/zh key parity, mint broken-links clean for these files.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
ysyneu
added a commit
that referenced
this pull request
Jun 24, 2026
The safari OpenAPI spec already defines the session operations (added in #97, exposed as app_key-callable in #69), but the "AI SRE" API-reference group in docs.json uses an explicit `pages` allow-list (Skills / MCP servers / A2A agents) — Mintlify renders ONLY listed operations, so the session endpoints were silently absent from the docs site. Add a "Sessions" / "会话" subgroup (en + zh) listing the five public session ops: list, get, export, cancel, delete.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Regenerates the AI SRE (safari) OpenAPI spec from the Go source of truth (fc-safari@feat/ai-sre handlers + types; fc-pgy@feat/ai-sre registry), via
/api-review scope ai-sre.Scope — 4 sub-modules, 27 public (
auth=all) opsget,list,export,delete, deprecatedcancelinterrupt/create/run/message/… areauth=serviceand stay out of the public spec.Highlights
safari/sessionas a proper bilingual sub-module: re-derived request schemas; took ownership of the large response schemas (SessionItem,EventItem,SessionTokenUsage,EnvironmentBinding,ContextResolvedItem) and translated the field descriptions that were previously English-only in the zh spec (62 strings).SessionListRequest.app_namewas missingswe.session/exportmodeled as anapplication/x-ndjsonstream;delete→ null;cancelmarkeddeprecatedwith anInterruptAckresponse.ExportLine/ExportUsageschemas.skill/upload(3/s, 30/min) andskill/download(5/s, 60/min) in the Restrictions tables — registry change in fc-pgy #568.skill/download→application/zipbinary; 14*scalarfields →["T","null"]nullable unions (SDK zero-value drop fix);skill_idexample prefixskill_.Files
Both per-module files (
safari.openapi.{en,zh}.json, rendered by Mintlify) and the consolidated reference copies (openapi.{en,zh}.json). Nodocs.jsonedit needed — the safari OpenAPI tab is spec-driven and auto-generates the sidebar from tags.Validation
$ref; en/zh schema-key & path parity.mint broken-linksclean for these files (only 6 pre-existing on-callstandard%20alertlinks remain, unrelated).Related code PRs (→
feat/ai-sre)validate:→binding:enforcement fix