docs(ai-sre): drop deprecated session/cancel from the public API#101
Merged
Conversation
`/safari/session/cancel` (pgy ID 7018) had its auth changed to `service`
(internal) — it is a deprecated alias that delegates to
`/safari/session/interrupt` (also `service`) and is kept registered only so
privately-deployed ai-assistant frontends keep working. It is no longer an
app_key-callable public endpoint, so it must not appear in the public OpenAPI.
Remove the operation from all four specs (safari.openapi.{en,zh}.json +
consolidated openapi.{en,zh}.json), drop the now-orphaned SessionCancelRequest
and SessionInterruptAck schemas, and remove the nav entry from docs.json
(en + zh). Session public surface is now list / get / export / delete.
|
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 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.)
ysyneu
added a commit
that referenced
this pull request
Jun 24, 2026
…ly) (#106) /safari/skill/download is reclassified auth=all -> jwt in the registry (fc-pgy #570): it is a console-only binary (application/zip) download used by the Customize UI via the session cookie, with no app_key consumer. Remove it from the public OpenAPI specs (per-module + consolidated, en+zh), the docs.json navigation, and the api-catalog overview (AI SRE 26->25, total 240->239). Mirrors the session/cancel removal (#101).
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.
Why
/safari/session/cancel(pgy registry ID 7018) has had its auth changed toservice(internal). It is a deprecated alias that delegates to/safari/session/interrupt(alsoservice), kept registered only so privately-deployed ai-assistant frontends that still POST to/cancelkeep working. It is no longer anapp_key-callable public endpoint, so it must not appear in the public OpenAPI.Change
/safari/session/canceloperation from all four specs:safari.openapi.{en,zh}.json+ consolidatedopenapi.{en,zh}.json.SessionCancelRequest+SessionInterruptAckschemas (each referenced only by the removed op)."POST /safari/session/cancel"nav entry fromdocs.json(en + zh) — it was just added in docs(ai-sre): add Sessions subgroup to the API reference nav #100.Public session surface is now list / get / export / delete.
Verification
/safari/session/cancel,SessionCancelRequest, orSessionInterruptAckanywhere; zero dangling$ref.docs.json; cancel is absent.ensure_ascii=False, indent=2).go-flashduty and flashduty-cli never wrapped
cancel, so no SDK/CLI change is needed.