Skip to content

docs(api-reference): daily api-review 2026-10-26 — dashboard application_id, session turn_in_flight #1132

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ysyneu merged 1 commit into from
Oct 26, 2026
Merged

docs(api-reference): daily api-review 2026-10-26 — dashboard application_id, session turn_in_flight #1132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 33 additions & 1 deletion api-reference/openapi.en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25076,6 +25076,10 @@
"type": "boolean",
"description": "True when an agent turn is currently in flight for this session."
},
"turn_in_flight": {
"type": "boolean",
"description": "`true` while a turn is executing. `is_running` additionally covers dispatched sub-task rounds that are still open."
},
"standing_tasks": {
"type": "integer",
"description": "Number of the session's process-type tasks (background shell commands or monitors) still alive when the response was built; 0 when none or when the count cannot be read."
Expand Down Expand Up @@ -25134,6 +25138,7 @@
"archived_at",
"pinned_at",
"is_running",
"turn_in_flight",
"standing_tasks",
"has_unread",
"current_turn_started_at",
Expand Down Expand Up @@ -34762,6 +34767,10 @@
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
"type": "string"
},
"application_id": {
"description": "Application the dashboard belongs to. Every query in `definition` must read this same application. 1 to 64 bytes.",
"type": "string"
},
"schema_version": {
"description": "Wire schema of the definition. Must be `dashboard.v1`.",
"enum": [
Expand All @@ -34775,6 +34784,7 @@
},
"required": [
"dashboard_id",
"application_id",
"schema_version",
"definition"
],
Expand Down Expand Up @@ -35063,6 +35073,10 @@
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
"type": "string"
},
"application_id": {
"description": "Application the dashboard belongs to.",
"type": "string"
},
"title": {
"description": "Dashboard title.",
"type": "string"
Expand All @@ -35087,6 +35101,7 @@
},
"required": [
"dashboard_id",
"application_id",
"title",
"revision",
"updated_by",
Expand All @@ -35101,6 +35116,10 @@
"description": "Search text, at most 128 characters. Split on spaces; each word must appear in the title or the description.",
"type": "string"
},
"application_id": {
"description": "Keep only the dashboards of this application. Omit to list the dashboards of every application.",
"type": "string"
},
"sort": {
"description": "Sort order, at most two unique fields; defaults to `updated_at` descending.",
"items": {
Expand Down Expand Up @@ -35456,6 +35475,10 @@
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
"type": "string"
},
"application_id": {
"description": "Application the dashboard belongs to. Fixed at creation.",
"type": "string"
},
"schema_version": {
"description": "Wire schema of the definition. Always `dashboard.v1`.",
"enum": [
Expand Down Expand Up @@ -35490,6 +35513,7 @@
},
"required": [
"dashboard_id",
"application_id",
"schema_version",
"revision",
"definition",
Expand Down Expand Up @@ -56031,6 +56055,7 @@
"content": {
"application/json": {
"example": {
"application_id": "qLpu24Dz4CAzWsESPbJYWA",
"dashboard_id": "0192f3a4-5b6c-7d8e-9f01-234567890abc",
"definition": {
"default_time_range": {
Expand Down Expand Up @@ -56237,6 +56262,7 @@
"application/json": {
"example": {
"data": {
"application_id": "qLpu24Dz4CAzWsESPbJYWA",
"created_at": 1792401120000,
"created_by": {
"id": 2477033058131,
Expand Down Expand Up @@ -56513,7 +56539,7 @@
"RUM/Dashboards"
],
"x-mint": {
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **300 requests/minute**; **20 requests/second** per account |\n| Permissions | **Dashboards Manage** (`rum`) |\n\n## Usage\n\n- `dashboard_id` is chosen by the caller and must be a canonical UUIDv7. Reusing an ID that already exists returns HTTP 409 `DashboardIDConflict`.\n- Every application a definition reads must exist in the account and be readable by the caller, otherwise the call fails with `InvalidParameter` or `AccessDenied`.\n- A failed `definition` validation returns HTTP 400 with up to 20 `violations`, each naming a `path`, a `rule` and a `message`, and the first one repeated as the error `message`.\n- Unknown request fields are rejected: the body is decoded strictly, so a typo fails with `InvalidParameter` instead of being ignored.\n- A body over 2 MiB, a definition over 1 MiB, or exceeding a count limit returns HTTP 413 `EntityTooLarge`; a `schema_version` other than `dashboard.v1` returns HTTP 422 `UnsupportedSchemaVersion`.",
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **300 requests/minute**; **20 requests/second** per account |\n| Permissions | **Dashboards Manage** (`rum`) |\n\n## Usage\n\n- `dashboard_id` is chosen by the caller and must be a canonical UUIDv7. Reusing an ID that already exists returns HTTP 409 `DashboardIDConflict`.\n- Every application a definition reads must exist in the account and be readable by the caller, otherwise the call fails with `InvalidParameter` or `AccessDenied`. The dashboard belongs to the single application named by `application_id`, and every query in `definition` must read that same application.\n- A failed `definition` validation returns HTTP 400 with up to 20 `violations`, each naming a `path`, a `rule` and a `message`, and the first one repeated as the error `message`.\n- Unknown request fields are rejected: the body is decoded strictly, so a typo fails with `InvalidParameter` instead of being ignored.\n- A body over 2 MiB, a definition over 1 MiB, or exceeding a count limit returns HTTP 413 `EntityTooLarge`; a `schema_version` other than `dashboard.v1` returns HTTP 422 `UnsupportedSchemaVersion`.",
"href": "/en/api-reference/rum/dashboards/rum-dashboard-write-create",
"metadata": {
"sidebarTitle": "Create dashboard"
Expand Down Expand Up @@ -56651,6 +56677,7 @@
"application/json": {
"example": {
"data": {
"application_id": "qLpu24Dz4CAzWsESPbJYWA",
"created_at": 1792401120000,
"created_by": {
"id": 2477033058131,
Expand Down Expand Up @@ -56958,6 +56985,7 @@
"data": {
"items": [
{
"application_id": "qLpu24Dz4CAzWsESPbJYWA",
"dashboard_id": "0192f3a4-5b6c-7d8e-9f01-234567890abc",
"description": "Loading time and error rate of the storefront.",
"revision": 3,
Expand Down Expand Up @@ -57045,6 +57073,7 @@
"application/json": {
"example": {
"data": {
"application_id": "qLpu24Dz4CAzWsESPbJYWA",
"created_at": 1792401120000,
"created_by": {
"id": 2477033058131,
Expand Down Expand Up @@ -58032,6 +58061,7 @@
"data": {
"changed": true,
"resource": {
"application_id": "qLpu24Dz4CAzWsESPbJYWA",
"created_at": 1792401120000,
"created_by": {
"id": 2477033058131,
Expand Down Expand Up @@ -65172,6 +65202,7 @@
"pinned_at": 0,
"last_event_at": 1780367992649,
"is_running": false,
"turn_in_flight": false,
"standing_tasks": 0,
"has_unread": false,
"current_turn_started_at": 1780367971241,
Expand Down Expand Up @@ -65325,6 +65356,7 @@
"pinned_at": 0,
"last_event_at": 1780367992649,
"is_running": false,
"turn_in_flight": false,
"standing_tasks": 0,
"has_unread": true,
"current_turn_started_at": 0,
Expand Down
34 changes: 33 additions & 1 deletion api-reference/openapi.zh.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25076,6 +25076,10 @@
"type": "boolean",
"description": "当该会话当前有正在进行的智能体轮次时为 true。"
},
"turn_in_flight": {
"type": "boolean",
"description": "`true` 表示当前有轮次正在执行；`is_running` 还覆盖仍在进行中的子任务轮次。"
},
"standing_tasks": {
"type": "integer",
"description": "生成响应时该会话仍存活的进程型任务数（后台命令或 monitor）；没有或无法读取时为 0。"
Expand Down Expand Up @@ -25134,6 +25138,7 @@
"archived_at",
"pinned_at",
"is_running",
"turn_in_flight",
"standing_tasks",
"has_unread",
"current_turn_started_at",
Expand Down Expand Up @@ -34762,6 +34767,10 @@
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
"type": "string"
},
"application_id": {
"description": "看板所属的应用。`definition` 中的每个查询都必须读取同一个应用。长度 1～64 字节。",
"type": "string"
},
"schema_version": {
"description": "定义所遵循的接口 schema，必须为 `dashboard.v1`。",
"enum": [
Expand All @@ -34775,6 +34784,7 @@
},
"required": [
"dashboard_id",
"application_id",
"schema_version",
"definition"
],
Expand Down Expand Up @@ -35063,6 +35073,10 @@
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
"type": "string"
},
"application_id": {
"description": "看板所属的应用。",
"type": "string"
},
"title": {
"description": "仪表盘标题。",
"type": "string"
Expand All @@ -35087,6 +35101,7 @@
},
"required": [
"dashboard_id",
"application_id",
"title",
"revision",
"updated_by",
Expand All @@ -35101,6 +35116,10 @@
"description": "搜索文本，最多 128 个字符。按空格拆分，每个词都须出现在标题或描述中。",
"type": "string"
},
"application_id": {
"description": "只返回该应用下的看板；不传则返回所有应用的看板。",
"type": "string"
},
"sort": {
"description": "排序方式，最多两个且不重复的字段；默认按 `updated_at` 倒序。",
"items": {
Expand Down Expand Up @@ -35456,6 +35475,10 @@
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
"type": "string"
},
"application_id": {
"description": "看板所属的应用，创建时指定。",
"type": "string"
},
"schema_version": {
"description": "定义所遵循的接口 schema，固定为 `dashboard.v1`。",
"enum": [
Expand Down Expand Up @@ -35490,6 +35513,7 @@
},
"required": [
"dashboard_id",
"application_id",
"schema_version",
"revision",
"definition",
Expand Down Expand Up @@ -56031,6 +56055,7 @@
"content": {
"application/json": {
"example": {
"application_id": "qLpu24Dz4CAzWsESPbJYWA",
"dashboard_id": "0192f3a4-5b6c-7d8e-9f01-234567890abc",
"definition": {
"default_time_range": {
Expand Down Expand Up @@ -56237,6 +56262,7 @@
"application/json": {
"example": {
"data": {
"application_id": "qLpu24Dz4CAzWsESPbJYWA",
"created_at": 1792401120000,
"created_by": {
"id": 2477033058131,
Expand Down Expand Up @@ -56513,7 +56539,7 @@
"RUM/仪表盘"
],
"x-mint": {
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **300 次/分钟**；**20 次/秒** |\n| 权限要求 | **看板管理**（`rum`） |\n\n## 使用说明\n\n- `dashboard_id` 由调用方生成，必须是规范 UUIDv7。复用已存在的 ID 会返回 HTTP 409 `DashboardIDConflict`。\n- 定义中读取的每个应用必须存在于本账户且调用方可读，否则返回 `InvalidParameter` 或 `AccessDenied`。\n- 定义校验失败时返回 HTTP 400，并带最多 20 条 `violations`，每条包含 `path`、`rule`、`message`，其中第一条同时作为错误 `message`。\n- 请求体按严格模式解码，未知字段会被拒绝并以 `InvalidParameter` 报错，而不是被忽略。\n- 请求体超过 2 MiB、定义超过 1 MiB 或超出数量上限时返回 HTTP 413 `EntityTooLarge`；`schema_version` 不是 `dashboard.v1` 时返回 HTTP 422 `UnsupportedSchemaVersion`。",
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **300 次/分钟**；**20 次/秒** |\n| 权限要求 | **看板管理**（`rum`） |\n\n## 使用说明\n\n- `dashboard_id` 由调用方生成，必须是规范 UUIDv7。复用已存在的 ID 会返回 HTTP 409 `DashboardIDConflict`。\n- 定义中读取的每个应用必须存在于本账户且调用方可读，否则返回 `InvalidParameter` 或 `AccessDenied`。看板归属于 `application_id` 指定的那一个应用，`definition` 中的每个查询都必须读取该应用。\n- 定义校验失败时返回 HTTP 400，并带最多 20 条 `violations`，每条包含 `path`、`rule`、`message`，其中第一条同时作为错误 `message`。\n- 请求体按严格模式解码，未知字段会被拒绝并以 `InvalidParameter` 报错，而不是被忽略。\n- 请求体超过 2 MiB、定义超过 1 MiB 或超出数量上限时返回 HTTP 413 `EntityTooLarge`；`schema_version` 不是 `dashboard.v1` 时返回 HTTP 422 `UnsupportedSchemaVersion`。",
"href": "/zh/api-reference/rum/dashboards/rum-dashboard-write-create",
"metadata": {
"sidebarTitle": "创建仪表盘"
Expand Down Expand Up @@ -56651,6 +56677,7 @@
"application/json": {
"example": {
"data": {
"application_id": "qLpu24Dz4CAzWsESPbJYWA",
"created_at": 1792401120000,
"created_by": {
"id": 2477033058131,
Expand Down Expand Up @@ -56958,6 +56985,7 @@
"data": {
"items": [
{
"application_id": "qLpu24Dz4CAzWsESPbJYWA",
"dashboard_id": "0192f3a4-5b6c-7d8e-9f01-234567890abc",
"description": "商城的加载耗时与错误率。",
"revision": 3,
Expand Down Expand Up @@ -57045,6 +57073,7 @@
"application/json": {
"example": {
"data": {
"application_id": "qLpu24Dz4CAzWsESPbJYWA",
"created_at": 1792401120000,
"created_by": {
"id": 2477033058131,
Expand Down Expand Up @@ -58032,6 +58061,7 @@
"data": {
"changed": true,
"resource": {
"application_id": "qLpu24Dz4CAzWsESPbJYWA",
"created_at": 1792401120000,
"created_by": {
"id": 2477033058131,
Expand Down Expand Up @@ -65172,6 +65202,7 @@
"pinned_at": 0,
"last_event_at": 1780367992649,
"is_running": false,
"turn_in_flight": false,
"standing_tasks": 0,
"has_unread": false,
"current_turn_started_at": 1780367971241,
Expand Down Expand Up @@ -65325,6 +65356,7 @@
"pinned_at": 0,
"last_event_at": 1780367992649,
"is_running": false,
"turn_in_flight": false,
"standing_tasks": 0,
"has_unread": true,
"current_turn_started_at": 0,
Expand Down
Loading
Loading