Skip to content

Commit b45f207

Browse files
committed
docs(api): explain safari enum values, add participant access source
Every safari enum value is now named in its description. SessionItem .access_source gains participant, a value the API actively assigns but the spec did not list; manager is documented as reserved.
1 parent fe673b5 commit b45f207

4 files changed

Lines changed: 80 additions & 76 deletions

File tree

api-reference/openapi.en.json

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -50826,7 +50826,7 @@
5082650826
},
5082750827
"auth_mode": {
5082850828
"type": "string",
50829-
"description": "Authentication mode.",
50829+
"description": "Authentication mode. One of: `shared` (a single static credential saved on the resource and shared by all callers in the account; the default — an empty value behaves the same), `per_user_secret` (each user stores their own secret per `secret_schema`, injected per user at runtime), `per_user_oauth` (each user completes their own OAuth grant; discovery and registration run lazily on first use).",
5083050830
"enum": [
5083150831
"shared",
5083250832
"per_user_secret",
@@ -51110,7 +51110,7 @@
5111051110
},
5111151111
"environment_kind": {
5111251112
"type": "string",
51113-
"description": "Runtime environment kind. Omit or send an empty value for automatic selection.",
51113+
"description": "Runtime environment kind. Omit or send an empty value for automatic selection. One of: `cloud` (platform-hosted cloud sandbox), `byoc` (a self-hosted BYOC runner in the account, used with `environment_id`); automatic selection prefers an online BYOC runner and falls back to the cloud sandbox.",
5111451114
"enum": [
5111551115
"",
5111651116
"cloud",
@@ -51206,7 +51206,7 @@
5120651206
"person",
5120751207
"team"
5120851208
],
51209-
"description": "Hidden session run scope."
51209+
"description": "Hidden session run scope. One of: `person` (personal rule, team_id=0, runs as the creator; disabled when the creator leaves the account), `team` (team rule, team_id>0, owned by the team and shared with its members; survives the creator leaving). Derived from the rule's team_id."
5121051210
},
5121151211
"cron_expr": {
5121251212
"type": "string",
@@ -51222,7 +51222,7 @@
5122251222
},
5122351223
"environment_kind": {
5122451224
"type": "string",
51225-
"description": "Runtime environment kind. Omit or send an empty value for automatic selection.",
51225+
"description": "Runtime environment kind. Omit or send an empty value for automatic selection. One of: `cloud` (platform-hosted cloud sandbox), `byoc` (self-hosted BYOC runner in the account); an empty value means automatic selection (prefers an online BYOC runner, falls back to the cloud sandbox).",
5122651226
"enum": [
5122751227
"",
5122851228
"cloud",
@@ -51555,7 +51555,7 @@
5155551555
"http_post",
5155651556
"oncall_incident"
5155751557
],
51558-
"description": "Trigger kind."
51558+
"description": "Trigger kind. One of:\n| Value | Meaning |\n| --- | --- |\n| `schedule` | Fired by the rule's schedule trigger |\n| `debug` | Debug run (reserved; current rule runs never carry this kind) |\n| `manual` | Triggered manually by a user |\n| `http_post` | Fired via the rule's HTTP POST webhook |\n| `oncall_incident` | Fired by an on-call incident event |"
5155951559
},
5156051560
"occurrence_key": {
5156151561
"type": "string",
@@ -51573,7 +51573,7 @@
5157351573
"skipped",
5157451574
"abandoned"
5157551575
],
51576-
"description": "Run status."
51576+
"description": "Run status. One of (the first three are in-flight, the rest terminal):\n| Value | Meaning |\n| --- | --- |\n| `queued` | Enqueued, waiting for a worker |\n| `running` | Executing |\n| `retrying` | An attempt failed and a retry is scheduled |\n| `succeeded` | Completed successfully |\n| `partial` | Partially succeeded (currently only produced by memory-consolidation runs; rule runs never reach it) |\n| `failed` | Terminal failure, no further retries |\n| `skipped` | Not executed (e.g. grace period expired, trigger or rule invalid); the reason is kept on the run record |\n| `abandoned` | Still in-flight past the stale threshold and swept as never-completed (e.g. worker died) |"
5157751577
},
5157851578
"attempts": {
5157951579
"type": "integer",
@@ -51917,7 +51917,7 @@
5191751917
},
5191851918
"status": {
5191951919
"type": "string",
51920-
"description": "Event status.",
51920+
"description": "Event status. One of: `normal` (a live event included in the context fed to the model), `compressed` (folded into a compaction summary boundary event; no longer loaded for the model, kept as history only).",
5192151921
"enum": [
5192251922
"normal",
5192351923
"compressed"
@@ -52027,7 +52027,7 @@
5202752027
},
5202852028
"environment_kind": {
5202952029
"type": "string",
52030-
"description": "Pin the server to a specific BYOC runner (`environment_id` required). Omit or send empty for automatic selection; `cloud` is not supported for MCP servers.",
52030+
"description": "Pin the server to a specific BYOC runner (`environment_id` required). Omit or send empty for automatic selection; `cloud` is not supported for MCP servers. The only accepted value: `byoc` (a self-hosted BYOC runner in the account; the MCP server process runs on the customer's own infrastructure).",
5203152031
"enum": [
5203252032
"byoc"
5203352033
]
@@ -52129,7 +52129,7 @@
5212952129
},
5213052130
"transport": {
5213152131
"type": "string",
52132-
"description": "Transport protocol.",
52132+
"description": "Transport protocol. One of: `stdio` (standard I/O to a local subprocess), `sse` (standalone SSE, the legacy MCP transport), `streamable-http` (the newer HTTP streaming transport).",
5213352133
"enum": [
5213452134
"stdio",
5213552135
"sse",
@@ -52210,7 +52210,7 @@
5221052210
},
5221152211
"auth_mode": {
5221252212
"type": "string",
52213-
"description": "Authentication mode.",
52213+
"description": "Authentication mode. One of: `shared` (a single static credential saved on the resource and shared by all callers in the account; the default — an empty value behaves the same), `per_user_secret` (each user stores their own secret per `secret_schema`, injected per user at runtime), `per_user_oauth` (each user completes their own OAuth grant; discovery and registration run lazily on first use).",
5221452214
"enum": [
5221552215
"shared",
5221652216
"per_user_secret",
@@ -52534,7 +52534,7 @@
5253452534
"person",
5253552535
"team"
5253652536
],
52537-
"description": "Resolved run scope for this run; mirrors the rule's run_scope."
52537+
"description": "Resolved run scope for this run; mirrors the rule's run_scope. One of: `person` (personal rule, runs as its creator), `team` (team rule, runs under the owning team)."
5253852538
},
5253952539
"owner_id": {
5254052540
"type": "integer",
@@ -52690,7 +52690,7 @@
5269052690
},
5269152691
"entry_kind": {
5269252692
"type": "string",
52693-
"description": "Surface that created the session.",
52693+
"description": "Surface that created the session. One of:\n| Value | Meaning |\n| --- | --- |\n| `web` | Created from the web console |\n| `im` | Created from an IM client (IM bot / IM H5) |\n| `api` | Created via the public API |\n| `automation` | Created by an automation rule (unattended run) |\n| `subagent` | Child session spawned by a parent's agent_dispatch (audit label; at runtime it executes on the web tool surface) |",
5269452694
"enum": [
5269552695
"web",
5269652696
"im",
@@ -52734,12 +52734,13 @@
5273452734
},
5273552735
"access_source": {
5273652736
"type": "string",
52737-
"description": "How the caller received access to this session. Omitted when no access source is resolved.",
52737+
"description": "How the caller received access to this session. Omitted when no access source is resolved. One of:\n| Value | Meaning |\n| --- | --- |\n| `owner` | Caller is the session creator (full access) |\n| `team_member` | Caller belongs to the session's bound team (full access) |\n| `manager` | Manager grant (reserved; never produced by the current version) |\n| `share_link` | Granted via a valid share link (view/fork only; cannot continue or manage) |\n| `participant` | Same-account non-member granted via a participable team session (view/continue/fork only) |",
5273852738
"enum": [
5273952739
"owner",
5274052740
"team_member",
5274152741
"manager",
52742-
"share_link"
52742+
"share_link",
52743+
"participant"
5274352744
]
5274452745
},
5274552746
"share_enabled": {
@@ -52763,7 +52764,7 @@
5276352764
},
5276452765
"status": {
5276552766
"type": "string",
52766-
"description": "Lifecycle status.",
52767+
"description": "Lifecycle status. One of: `enabled` (active), `deleted` (soft-deleted, no longer accessible).",
5276752768
"enum": [
5276852769
"enabled",
5276952770
"deleted"
@@ -52892,7 +52893,7 @@
5289252893
"properties": {
5289352894
"app_name": {
5289452895
"type": "string",
52895-
"description": "Agent app whose sessions to list.",
52896+
"description": "Agent app whose sessions to list. One of:\n| Value | Meaning |\n| --- | --- |\n| `ask-ai` | Ask AI assistant |\n| `support` | Customer-support agent |\n| `support-website` | Website support agent (exposed over A2A, not built into the console) |\n| `support-flashcat` | Flashcat-site support agent (exposed over A2A) |\n| `ai-sre` | The AI SRE main app |\n| `template-assistant` | Notification-template assistant (template editing/validation) |\n| `swe` | Internal benchmarking app (not customer-facing) |",
5289652897
"enum": [
5289752898
"ask-ai",
5289852899
"support",
@@ -58363,7 +58364,7 @@
5836358364
"properties": {
5836458365
"code": {
5836558366
"type": "string",
58366-
"description": "Warning code.",
58367+
"description": "Warning code. One of: `unresolved_reference` (an @ref in the written file's content points to a file that does not exist in the pack; `ref` carries it), `still_referenced_by` (the deleted file is still @ref-referenced by other files in the pack; `refs` lists the referrers).",
5836758368
"enum": [
5836858369
"unresolved_reference",
5836958370
"still_referenced_by"
@@ -58404,7 +58405,7 @@
5840458405
},
5840558406
"scope": {
5840658407
"type": "string",
58407-
"description": "Restrict to one scope; `all` (default) overrides `include_account`.",
58408+
"description": "Restrict to one scope; `all` (default) overrides `include_account`. One of: `all` (account scope plus visible team scopes), `account` (account-level packs only), `team` (team-level packs only, can be combined with `team_ids`).",
5840858409
"enum": [
5840958410
"all",
5841058411
"account",
@@ -58439,7 +58440,7 @@
5843958440
"properties": {
5844058441
"scope": {
5844158442
"type": "string",
58442-
"description": "Scope of the pack to ensure.",
58443+
"description": "Scope of the pack to ensure. One of: `account` (account-level pack; scope_id is forced to the caller's account ID and only account admins may create it; first creation seeds a default DUTY.md), `team` (team-level pack; the `scope_id` team ID is required and the caller must belong to that team).",
5844358444
"enum": [
5844458445
"account",
5844558446
"team"

0 commit comments

Comments
 (0)