Skip to content

docs(api): sync OpenAPI specs with backend API changes - #461

Open
ysyneu wants to merge 1 commit into
feat/api-review-syncfrom
feat/api-spec-sync-20260923
Open

ysyneu wants to merge 1 commit into
feat/api-review-syncfrom
feat/api-spec-sync-20260923

Conversation

@ysyneu

@ysyneu ysyneu commented Sep 23, 2026

Copy link
Copy Markdown
Contributor

What

Syncs the public API reference with backend API behavior changes shipped this week:

AI SRE (safari.openapi.*.json)

  • Automation rules: new oncall_incident_merge_similar field (create/update requests and rule items)
  • Automation runs: new joined_session_id / joined_session_name on run items (fan-in skips)
  • Sessions: new has_open_tasks on session items (populated by session/get only)
  • Artifacts: pinned_at documented in the published-artifact schema; artifact stream rate limits corrected to 50 rps / 1,000 rpm
  • Session export events: root_invocation_id, delivery_mode, is_error

Monitors (monitors.openapi.*.json)

  • Datasources: document the team-permission fields manage_team_id / readonly_team_ids / creator_id and my_perm on list items (new DataSourceListItem schema)

On-call (on-call.openapi.*.json)

  • Incidents: effective_person_ids on assigned_to

Navigation

  • Unlist POST /member/notify from the site navigation and endpoint catalog (callable only with AI SRE session credentials; covered by the Go SDK guide). Spec schema intentionally kept for SDK generation. Catalog counts 338 → 337 (Platform 28 → 27).

All operation-level changes are mirrored into the consolidated openapi.en/zh.json.

Validation

  • python3 scripts/lint_openapi.py → 0 (12 spec files, no violations)
  • EN/ZH structural parity verified (identical paths, operationIds, schema keys, property keys)
  • Request/response examples updated for the new fields

- safari (AI SRE): add oncall_incident_merge_similar to automation rule
  create/update/item; joined_session_id/joined_session_name to run items;
  has_open_tasks to session item (session/get only); pinned_at to
  published artifact items; root_invocation_id/delivery_mode/is_error to
  event items; artifact stream rate limits to 50 rps / 1,000 rpm
- monitors: document datasource team-permission fields (manage_team_id,
  readonly_team_ids, creator_id) and my_perm on datasource list items
- on-call: add effective_person_ids to AssignedTo in incident payloads
- api catalog: unlist POST /member/notify page (session-credential-only
  endpoint, covered by the Go SDK guide); counts 338 to 337
- mirror all spec changes into the consolidated openapi.en/zh.json

This branch has not been deployed

No deployments
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