Skip to content

docs(ai-sre): add Sessions subgroup to the API reference nav#100

Merged
ysyneu merged 1 commit into
mainfrom
fix/docs-ai-sre-sessions-nav
Jun 24, 2026
Merged

docs(ai-sre): add Sessions subgroup to the API reference nav#100
ysyneu merged 1 commit into
mainfrom
fix/docs-ai-sre-sessions-nav

Conversation

@ysyneu

@ysyneu ysyneu commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

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.json uses an explicit pages allow-list (every module here does — Mintlify renders only the operations listed in pages, 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 · /delete

Verification

  • docs.json is valid JSON.
  • All five /safari/session/* paths exist in both safari.openapi.en.json and safari.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 pages allow-list that must be reconciled when ops are added.

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.
@mintlify

mintlify Bot commented Jun 24, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated (UTC)
flashduty 🟢 Ready View Preview Jun 24, 2026, 12:03 PM

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

@ysyneu
ysyneu merged commit c7c55b2 into main Jun 24, 2026
1 check passed
@ysyneu
ysyneu deleted the fix/docs-ai-sre-sessions-nav branch June 24, 2026 12:13
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.)
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