docs(ai-sre): add Sessions subgroup to the API reference nav#100
Merged
Conversation
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.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This was referenced Jun 24, 2026
ysyneu
added a commit
that referenced
this pull request
Jun 24, 2026
The API catalog (the hand-maintained master index) listed the AI SRE skill / MCP / A2A operations but had no Sessions section — the session endpoints were never added when they were adopted into the spec, the same gap that left them out of the API-reference nav (#100). Add a Sessions section (en + zh) listing the four public session operations — list / get / export / delete — and bump the AI SRE count 22 → 26 and the total 236 → 240. (cancel was dropped in #101: it is now auth=service / internal.)
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
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.
Why
The safari OpenAPI spec already defines the session operations — they were adopted into the spec in #97 and exposed as app_key-callable endpoints in #69. But the "AI SRE" API-reference group in
docs.jsonuses an explicitpagesallow-list (every module here does — Mintlify renders only the operations listed inpages, not every op in the spec). That allow-list had Skills / MCP servers / A2A agents but no Sessions subgroup, so the session endpoints were silently absent from the published docs site even though the spec, SDK (go-flashduty), CLI (fduty safari session-*), and pgy registry all have them.Change
Add a "Sessions" / "会话" subgroup (en + zh) to the AI SRE group, listing the five public session operations:
POST /safari/session/list · /get · /export · /cancel · /deleteVerification
docs.jsonis valid JSON./safari/session/*paths exist in bothsafari.openapi.en.jsonandsafari.openapi.zh.json, so each nav entry resolves.Companion
The api-review skill is being fixed in parallel (claude-plugins-flashduty) so this class of gap can't recur — its SKILL.md wrongly stated "no navigation edits needed", but every module uses an explicit
pagesallow-list that must be reconciled when ops are added.