Skip to content

docs(api): api-review daily audit 2026-10-13 — localize Monitors zh 200 descriptions, refresh work-item Usage #1047

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 13, 2026
Merged

docs(api): api-review daily audit 2026-10-13 — localize Monitors zh 200 descriptions, refresh work-item Usage #1047

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
36 changes: 18 additions & 18 deletions api-reference/monitors.openapi.zh.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2421,7 +2421,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -2699,7 +2699,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -2886,7 +2886,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -3168,7 +3168,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -3357,7 +3357,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -3434,7 +3434,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -3620,7 +3620,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -3725,7 +3725,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -3829,7 +3829,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -3929,7 +3929,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -4019,7 +4019,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -4199,7 +4199,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -4342,7 +4342,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -4463,7 +4463,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -4612,7 +4612,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -4738,7 +4738,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -4899,7 +4899,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -5124,7 +5124,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down
6 changes: 3 additions & 3 deletions api-reference/on-call.openapi.en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17321,7 +17321,7 @@
"On-call/Incidents"
],
"x-mint": {
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Incidents Read** (`on-call`) |\n\n## Usage\n\n- At least one of `incident_id`, `post_mortem_id`, or `assignee_id` is required.\n- Cursor pagination sorted by `updated_at_seconds` descending — pass the previous response's `next_cursor` as `cursor` until `has_more` is false.\n- Listing by `incident_id` also includes follow-ups anchored on the incident's post-mortem.\n- Listing by `assignee_id` alone requires being that assignee or an account admin.",
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Incidents Read** (`on-call`) |\n\n## Usage\n\n- At least one of `incident_id`, `post_mortem_id`, `assignee_id`, or `assignee_type` = `ai_sre` is required.\n- `assignee_type` = `ai_sre` lists items assigned to AI SRE and can be used on its own.\n- Cursor pagination sorted by `updated_at_seconds` descending — pass the previous response's `next_cursor` as `cursor` until `has_more` is false.\n- Listing by `incident_id` also includes follow-ups anchored on the incident's post-mortem.\n- Listing by `assignee_id` alone requires being that assignee or an account admin.",
"href": "/en/api-reference/on-call/incidents/incident-work-item-list",
"metadata": {
"sidebarTitle": "List work items"
Expand Down Expand Up @@ -17433,7 +17433,7 @@
"On-call/Incidents"
],
"x-mint": {
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Incidents Manage** (`on-call`) |\n\n## Usage\n\n- Requires the On-call Pro license.\n- An `action` anchors to an active incident and must NOT set `post_mortem_id`; a `follow_up` REQUIRES the `post_mortem_id` of a post-mortem linked to `incident_id`.\n- Assignees must be active members who can already read the anchor incident or post-mortem — assignment never grants access.\n- Newly added assignees are notified.\n- Retrying with the same (`creator`, `idempotency_key`) replays the original item with `idempotent_replay: true` instead of creating a duplicate.\n- Audited — changes are recorded in the audit log.",
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Incidents Manage** (`on-call`) |\n\n## Usage\n\n- Requires the On-call Pro license.\n- An `action` anchors to an active incident and must NOT set `post_mortem_id`; a `follow_up` REQUIRES the `post_mortem_id` of a post-mortem linked to `incident_id`.\n- Set either `assignees` or the legacy `assignee_ids`, not both. `assignees` entries are `{type, id?}` with `type` `person` or `ai_sre`; an `ai_sre` entry omits `id`. `assignee_ids` is equivalent to an all-`person` list. Sending both returns an error.\n- Person assignees must be active members who can already read the anchor incident or post-mortem — assignment never grants access.\n- Newly added assignees are notified.\n- Retrying with the same (`creator`, `idempotency_key`) replays the original item with `idempotent_replay: true` instead of creating a duplicate.\n- Audited — changes are recorded in the audit log.",
"href": "/en/api-reference/on-call/incidents/incident-work-item-create",
"metadata": {
"sidebarTitle": "Create a work item"
Expand Down Expand Up @@ -17882,7 +17882,7 @@
"On-call/Incidents"
],
"x-mint": {
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Incidents Manage** (`on-call`) |\n\n## Usage\n\n- Requires the On-call Pro license.\n- Full replacement of the assignee set — an empty array clears all assignees.\n- Only newly added assignees are notified; removals never notify.\n- Audited — changes are recorded in the audit log.",
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Incidents Manage** (`on-call`) |\n\n## Usage\n\n- Requires the On-call Pro license.\n- Full replacement of the assignee set — an empty array clears all assignees.\n- Set either `assignees` or the legacy `assignee_ids`, not both (sending both returns an error). An `ai_sre` entry omits `id`.\n- Only newly added assignees are notified; removals never notify.\n- Audited — changes are recorded in the audit log.",
"href": "/en/api-reference/on-call/incidents/incident-work-item-reset-assignees",
"metadata": {
"sidebarTitle": "Reset work item assignees"
Expand Down
6 changes: 3 additions & 3 deletions api-reference/on-call.openapi.zh.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17321,7 +17321,7 @@
"On-call/故障管理"
],
"x-mint": {
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **故障查看**（`on-call`） |\n\n## 使用说明\n\n- `incident_id`、`post_mortem_id`、`assignee_id` 至少提供一个。\n- 按 `updated_at_seconds` 倒序的游标分页 —— 将上一次响应的 `next_cursor` 作为 `cursor` 传入，直到 `has_more` 为 false。\n- 按 `incident_id` 查询时，同时包含锚定在该故障复盘上的后续行动。\n- 仅按 `assignee_id` 查询时，须为本人或账户管理员。",
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **故障查看**（`on-call`） |\n\n## 使用说明\n\n- `incident_id`、`post_mortem_id`、`assignee_id`，或 `assignee_type` 为 `ai_sre`，至少满足一个。\n- `assignee_type` 为 `ai_sre` 时返回指派给 AI SRE 的事项，可单独作为查询条件。\n- 按 `updated_at_seconds` 倒序的游标分页 —— 将上一次响应的 `next_cursor` 作为 `cursor` 传入，直到 `has_more` 为 false。\n- 按 `incident_id` 查询时，同时包含锚定在该故障复盘上的后续行动。\n- 仅按 `assignee_id` 查询时，须为本人或账户管理员。",
"href": "/zh/api-reference/on-call/incidents/incident-work-item-list",
"metadata": {
"sidebarTitle": "查询跟进事项列表"
Expand Down Expand Up @@ -17433,7 +17433,7 @@
"On-call/故障管理"
],
"x-mint": {
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **故障管理**（`on-call`） |\n\n## 使用说明\n\n- 需要 On-call Pro 许可。\n- `action` 锚定活动故障，且不得设置 `post_mortem_id`；`follow_up` 必须设置为关联到 `incident_id` 的故障复盘 ID。\n- 负责人须为已能查看锚定故障或复盘的活跃成员 —— 指派不会授予访问权限。\n- 新添加的负责人会收到通知。\n- 以相同的（`creator`、`idempotency_key`）重试时，返回原事项并标记 `idempotent_replay: true`，不会创建重复事项。\n- 已审计 —— 变更会记录到审计日志。",
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **故障管理**（`on-call`） |\n\n## 使用说明\n\n- 需要 On-call Pro 许可。\n- `action` 锚定活动故障，且不得设置 `post_mortem_id`；`follow_up` 必须设置为关联到 `incident_id` 的故障复盘 ID。\n- 使用 `assignees`（`person` 带 `id`，或 `ai_sre` 不带 `id`），或使用旧版 `assignee_ids`（全部为 `person`）。两者同时出现会报错。\n- 人员负责人须为已能查看锚定故障或复盘的活跃成员 —— 指派不会授予访问权限。\n- 新添加的负责人会收到通知。\n- 以相同的（`creator`、`idempotency_key`）重试时，返回原事项并标记 `idempotent_replay: true`，不会创建重复事项。\n- 已审计 —— 变更会记录到审计日志。",
"href": "/zh/api-reference/on-call/incidents/incident-work-item-create",
"metadata": {
"sidebarTitle": "创建跟进事项"
Expand Down Expand Up @@ -17882,7 +17882,7 @@
"On-call/故障管理"
],
"x-mint": {
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **故障管理**（`on-call`） |\n\n## 使用说明\n\n- 需要 On-call Pro 许可。\n- 整体替换负责人集合 —— 空数组表示清空所有负责人。\n- 仅新添加的负责人会收到通知；移除不通知。\n- 已审计 —— 变更会记录到审计日志。",
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **故障管理**（`on-call`） |\n\n## 使用说明\n\n- 需要 On-call Pro 许可。\n- 整体替换负责人集合 —— 空数组表示清空所有负责人。\n- 使用 `assignees` 或旧版 `assignee_ids`。两者同时出现会报错。`ai_sre` 条目不带 `id`。\n- 仅新添加的负责人会收到通知；移除不通知。\n- 已审计 —— 变更会记录到审计日志。",
"href": "/zh/api-reference/on-call/incidents/incident-work-item-reset-assignees",
"metadata": {
"sidebarTitle": "重置跟进事项负责人"
Expand Down
36 changes: 18 additions & 18 deletions api-reference/openapi.zh.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64386,7 +64386,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -64664,7 +64664,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -64851,7 +64851,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -65133,7 +65133,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -65322,7 +65322,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -65399,7 +65399,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -65585,7 +65585,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -65690,7 +65690,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -65794,7 +65794,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -65894,7 +65894,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -65984,7 +65984,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -66164,7 +66164,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -66307,7 +66307,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -66428,7 +66428,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -66577,7 +66577,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -66703,7 +66703,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -66864,7 +66864,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -67089,7 +67089,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down
Loading