|
50826 | 50826 | }, |
50827 | 50827 | "auth_mode": { |
50828 | 50828 | "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).", |
50830 | 50830 | "enum": [ |
50831 | 50831 | "shared", |
50832 | 50832 | "per_user_secret", |
|
51110 | 51110 | }, |
51111 | 51111 | "environment_kind": { |
51112 | 51112 | "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.", |
51114 | 51114 | "enum": [ |
51115 | 51115 | "", |
51116 | 51116 | "cloud", |
|
51206 | 51206 | "person", |
51207 | 51207 | "team" |
51208 | 51208 | ], |
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." |
51210 | 51210 | }, |
51211 | 51211 | "cron_expr": { |
51212 | 51212 | "type": "string", |
|
51222 | 51222 | }, |
51223 | 51223 | "environment_kind": { |
51224 | 51224 | "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).", |
51226 | 51226 | "enum": [ |
51227 | 51227 | "", |
51228 | 51228 | "cloud", |
|
51555 | 51555 | "http_post", |
51556 | 51556 | "oncall_incident" |
51557 | 51557 | ], |
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 |" |
51559 | 51559 | }, |
51560 | 51560 | "occurrence_key": { |
51561 | 51561 | "type": "string", |
|
51573 | 51573 | "skipped", |
51574 | 51574 | "abandoned" |
51575 | 51575 | ], |
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) |" |
51577 | 51577 | }, |
51578 | 51578 | "attempts": { |
51579 | 51579 | "type": "integer", |
|
51917 | 51917 | }, |
51918 | 51918 | "status": { |
51919 | 51919 | "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).", |
51921 | 51921 | "enum": [ |
51922 | 51922 | "normal", |
51923 | 51923 | "compressed" |
|
52027 | 52027 | }, |
52028 | 52028 | "environment_kind": { |
52029 | 52029 | "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).", |
52031 | 52031 | "enum": [ |
52032 | 52032 | "byoc" |
52033 | 52033 | ] |
|
52129 | 52129 | }, |
52130 | 52130 | "transport": { |
52131 | 52131 | "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).", |
52133 | 52133 | "enum": [ |
52134 | 52134 | "stdio", |
52135 | 52135 | "sse", |
|
52210 | 52210 | }, |
52211 | 52211 | "auth_mode": { |
52212 | 52212 | "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).", |
52214 | 52214 | "enum": [ |
52215 | 52215 | "shared", |
52216 | 52216 | "per_user_secret", |
|
52534 | 52534 | "person", |
52535 | 52535 | "team" |
52536 | 52536 | ], |
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)." |
52538 | 52538 | }, |
52539 | 52539 | "owner_id": { |
52540 | 52540 | "type": "integer", |
|
52690 | 52690 | }, |
52691 | 52691 | "entry_kind": { |
52692 | 52692 | "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) |", |
52694 | 52694 | "enum": [ |
52695 | 52695 | "web", |
52696 | 52696 | "im", |
@@ -52734,12 +52734,13 @@ |
52734 | 52734 | }, |
52735 | 52735 | "access_source": { |
52736 | 52736 | "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) |", |
52738 | 52738 | "enum": [ |
52739 | 52739 | "owner", |
52740 | 52740 | "team_member", |
52741 | 52741 | "manager", |
52742 | | - "share_link" |
| 52742 | + "share_link", |
| 52743 | + "participant" |
52743 | 52744 | ] |
52744 | 52745 | }, |
52745 | 52746 | "share_enabled": { |
|
52763 | 52764 | }, |
52764 | 52765 | "status": { |
52765 | 52766 | "type": "string", |
52766 | | - "description": "Lifecycle status.", |
| 52767 | + "description": "Lifecycle status. One of: `enabled` (active), `deleted` (soft-deleted, no longer accessible).", |
52767 | 52768 | "enum": [ |
52768 | 52769 | "enabled", |
52769 | 52770 | "deleted" |
|
52892 | 52893 | "properties": { |
52893 | 52894 | "app_name": { |
52894 | 52895 | "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) |", |
52896 | 52897 | "enum": [ |
52897 | 52898 | "ask-ai", |
52898 | 52899 | "support", |
|
58363 | 58364 | "properties": { |
58364 | 58365 | "code": { |
58365 | 58366 | "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).", |
58367 | 58368 | "enum": [ |
58368 | 58369 | "unresolved_reference", |
58369 | 58370 | "still_referenced_by" |
|
58404 | 58405 | }, |
58405 | 58406 | "scope": { |
58406 | 58407 | "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`).", |
58408 | 58409 | "enum": [ |
58409 | 58410 | "all", |
58410 | 58411 | "account", |
|
58439 | 58440 | "properties": { |
58440 | 58441 | "scope": { |
58441 | 58442 | "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).", |
58443 | 58444 | "enum": [ |
58444 | 58445 | "account", |
58445 | 58446 | "team" |
|
0 commit comments