From 81510c769fddf9eb69e1143542084f803aab3a96 Mon Sep 17 00:00:00 2001 From: Flashduty AI-SRE Date: Tue, 1 Sep 2026 08:26:37 +0000 Subject: [PATCH] =?UTF-8?q?docs(api):=20daily=20audit=202026-09-01=20?= =?UTF-8?q?=E2=80=94=20localize=20english=20text=20in=20ZH=20specs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Registry (auth=all, non-push) and committed specs both hold exactly 336 operations: zero added, zero removed. The only registry change since the last run is the Huawei AOM push rows, which are auth=integration and out of public scope. Text-only bilingual-contract fixes (146 lines, no structural change): - 52 ZH ops had responses.200.description 'Success' instead of '成功' - 15 on-call ZH ops carried the English tag 'On-call/Incidents', which is also undeclared in the ZH tags list; mapping.yaml tag_zh is 故障管理 - 2 rum ZH ops + their tag declaration carried 'RUM/Session replay' instead of mapping.yaml's 'RUM/RUM 会话回放' - /account/info 200 description 'OK' -> 'Success' (EN) / '成功' (ZH) - /rum/issue/export ZH 200 description translated to match sibling exports docs.json and both api-catalog.mdx files are untouched: no operation was added or removed, and all 336 paths are already present in the nav and catalogs. lint_openapi.py passes; split and consolidated stay identical. --- api-reference/on-call.openapi.zh.json | 52 ++++----- api-reference/openapi.en.json | 2 +- api-reference/openapi.zh.json | 144 ++++++++++++------------- api-reference/platform.openapi.en.json | 2 +- api-reference/platform.openapi.zh.json | 2 +- api-reference/rum.openapi.zh.json | 8 +- api-reference/safari.openapi.zh.json | 82 +++++++------- 7 files changed, 146 insertions(+), 146 deletions(-) diff --git a/api-reference/on-call.openapi.zh.json b/api-reference/on-call.openapi.zh.json index a7ae4cf..7c6cfed 100644 --- a/api-reference/on-call.openapi.zh.json +++ b/api-reference/on-call.openapi.zh.json @@ -896,7 +896,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/octet-stream": { "schema": { @@ -3430,7 +3430,7 @@ "summary": "获取故障时间线", "description": "获取指定故障的时间线动态，包括状态变更、评论和系统事件。", "tags": [ - "On-call/Incidents" + "On-call/故障管理" ], "x-mint": { "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **故障查看**（`on-call`） |\n\n## 使用说明\n\n- 对于 `i_comm` 条目，`detail.comment_type` 在读取时根据当前账户级评论类型定义解析，因此始终反映类型的最新名称和颜色。", @@ -4177,7 +4177,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/octet-stream": { "schema": { @@ -5762,7 +5762,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/octet-stream": { "schema": { @@ -8611,7 +8611,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/octet-stream": { "schema": { @@ -9836,7 +9836,7 @@ "summary": "评论故障", "description": "在故障时间线上添加文字评论。", "tags": [ - "On-call/Incidents" + "On-call/故障管理" ], "x-mint": { "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **故障管理**（`on-call`） |\n\n## 使用说明\n\n- 要提及成员，在 `comment` 中嵌入形如 `[@显示名](flashduty://ref/member/)` 的 markdown 链接。被提及的成员会收到专门的个人通知，不受 `mute_reply` 影响。\n- 不带链接语法的纯 `@名字` 文本不会形成提及。\n- 服务端会将每个提及的显示名改写为成员的规范名称。", @@ -12327,7 +12327,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -13708,7 +13708,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -13813,7 +13813,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -13898,7 +13898,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -13974,7 +13974,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -14061,7 +14061,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -14157,7 +14157,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -16164,7 +16164,7 @@ "summary": "查询评论类型列表", "description": "获取账户下全部评论类型，按展示位置排序。", "tags": [ - "On-call/Incidents" + "On-call/故障管理" ], "x-mint": { "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **故障查看**（`on-call`） |\n\n## 使用说明\n\n- 一次调用返回完整列表，不分页。\n- 每个账户最多可创建 10 个评论类型。", @@ -16257,7 +16257,7 @@ "summary": "创建评论类型", "description": "创建可附加到故障评论的评论类型。", "tags": [ - "On-call/Incidents" + "On-call/故障管理" ], "x-mint": { "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **评论类型管理**（`on-call`） |\n\n## 使用说明\n\n- 新类型追加到展示顺序的末尾。\n- 名称在账户内必须唯一（不区分大小写，忽略首尾空白）。\n- 每个账户最多可创建 10 个评论类型。\n- 该权限默认仅管理员拥有，自定义角色需显式授予。", @@ -16341,7 +16341,7 @@ "summary": "更新评论类型", "description": "更新已有账户评论类型的名称和/或颜色。", "tags": [ - "On-call/Incidents" + "On-call/故障管理" ], "x-mint": { "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **评论类型管理**（`on-call`） |\n\n## 使用说明\n\n- 部分更新 —— 仅修改提供的字段，但 `name` 和 `color` 至少提供一个。\n- 名称在账户内必须保持唯一（不区分大小写，忽略首尾空白）。\n- 该权限默认仅管理员拥有，自定义角色需显式授予。", @@ -16412,7 +16412,7 @@ "summary": "删除评论类型", "description": "删除评论类型。已使用该类型的评论保留文本内容，但不再显示类型标签。", "tags": [ - "On-call/Incidents" + "On-call/故障管理" ], "x-mint": { "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **评论类型管理**（`on-call`） |\n\n## 使用说明\n\n- 硬删除 —— 评论类型被永久移除，无法恢复。\n- 已引用该类型的评论会失去类型标签，其他内容不受影响。\n- 该权限默认仅管理员拥有，自定义角色需显式授予。", @@ -16482,7 +16482,7 @@ "summary": "调整评论类型顺序", "description": "传入账户全部评论类型 ID 的期望顺序，设置评论类型的展示顺序。", "tags": [ - "On-call/Incidents" + "On-call/故障管理" ], "x-mint": { "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **评论类型管理**（`on-call`） |\n\n## 使用说明\n\n- 全量排序 —— `comment_type_ids` 必须包含账户的全部评论类型，每个恰好出现一次，按期望顺序排列。\n- 展示位置从 1 开始重新分配：数组中的第一个 ID 即为位置 1。\n- 该权限默认仅管理员拥有，自定义角色需显式授予。", @@ -16555,7 +16555,7 @@ "summary": "查询跟进事项列表", "description": "查询故障跟进事项（行动项与复盘后续行动），使用游标分页。", "tags": [ - "On-call/Incidents" + "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` 查询时，须为本人或账户管理员。", @@ -16667,7 +16667,7 @@ "summary": "创建跟进事项", "description": "在活动故障上创建行动项，或在其故障复盘上创建后续行动。", "tags": [ - "On-call/Incidents" + "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- 已审计 —— 变更会记录到审计日志。", @@ -16766,7 +16766,7 @@ "summary": "更新跟进事项", "description": "部分更新跟进事项的标题、描述、状态或优先级。", "tags": [ - "On-call/Incidents" + "On-call/故障管理" ], "x-mint": { "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **故障管理**（`on-call`） |\n\n## 使用说明\n\n- 需要 On-call Pro 许可。\n- 部分更新：未提供的字段保持不变；显式传 `null` 则清空该字段。\n- 乐观锁 —— `version` 必须与事项当前版本一致；不一致返回冲突错误。\n- 负责人、`item_type` 以及故障/复盘锚点不能在此修改 —— 请使用专用接口。\n- 已审计 —— 变更会记录到审计日志。", @@ -16859,7 +16859,7 @@ "summary": "删除跟进事项", "description": "软删除跟进事项。", "tags": [ - "On-call/Incidents" + "On-call/故障管理" ], "x-mint": { "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **故障管理**（`on-call`） |\n\n## 使用说明\n\n- 需要 On-call Pro 许可。\n- 软删除 —— 事项不再出现在列表中，但数据仍保留。\n- 乐观锁 —— `version` 必须与事项当前版本一致；不一致返回冲突错误。\n- 已审计 —— 变更会记录到审计日志。", @@ -16930,7 +16930,7 @@ "summary": "完成跟进事项", "description": "通过设置客户端自定义的目标状态，将跟进事项标记为完成。", "tags": [ - "On-call/Incidents" + "On-call/故障管理" ], "x-mint": { "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **故障管理**（`on-call`） |\n\n## 使用说明\n\n- 需要 On-call Pro 许可。\n- 仅当前负责人可以完成跟进事项。\n- `target_status` 为客户端自定义字符串 —— 没有固定状态机。\n- 相同 `idempotency_key` 搭配相同 `target_status` 会幂等重放；相同键搭配不同 `target_status` 将返回错误。\n- 已审计 —— 变更会记录到审计日志。", @@ -17023,7 +17023,7 @@ "summary": "转化跟进事项为复盘后续行动", "description": "将故障行动项原地转化为故障复盘后续行动。", "tags": [ - "On-call/Incidents" + "On-call/故障管理" ], "x-mint": { "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **故障管理**（`on-call`） |\n\n## 使用说明\n\n- 需要 On-call Pro 许可。\n- 将 `action` 事项原地转化为复盘 `follow_up` —— `work_item_id` 不变。\n- 转化已是 `follow_up` 的事项时返回 `idempotent_replay: true`。\n- 如果故障已存在复盘，转化后的事项会自动绑定到该复盘。\n- 已审计 —— 变更会记录到审计日志。", @@ -17116,7 +17116,7 @@ "summary": "重置跟进事项负责人", "description": "整体替换跟进事项的负责人集合。", "tags": [ - "On-call/Incidents" + "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- 已审计 —— 变更会记录到审计日志。", @@ -17217,7 +17217,7 @@ "summary": "绑定跟进事项到复盘", "description": "将故障下已转化但未绑定的后续行动批量绑定到故障复盘。", "tags": [ - "On-call/Incidents" + "On-call/故障管理" ], "x-mint": { "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **故障管理**（`on-call`） |\n\n## 使用说明\n\n- 需要 On-call Pro 许可。\n- 一次调用将该故障全部已转化但未绑定的后续行动绑定到指定复盘。\n- `items` 为本次新绑定的批次；不设置 `next_cursor` 和 `has_more`。\n- 通过 `idempotency_key` 幂等 —— 以相同键重试时重放原始结果。\n- 已审计 —— 变更会记录到审计日志。", diff --git a/api-reference/openapi.en.json b/api-reference/openapi.en.json index 2f1d624..2ebeee2 100644 --- a/api-reference/openapi.en.json +++ b/api-reference/openapi.en.json @@ -21173,7 +21173,7 @@ }, "responses": { "200": { - "description": "OK", + "description": "Success", "content": { "application/json": { "schema": { diff --git a/api-reference/openapi.zh.json b/api-reference/openapi.zh.json index 0f68dc5..16fd93a 100644 --- a/api-reference/openapi.zh.json +++ b/api-reference/openapi.zh.json @@ -149,7 +149,7 @@ "description": "管理和查询用于 Browser、Android、iOS 错误符号化的 RUM Sourcemap 文件。" }, { - "name": "RUM/Session replay", + "name": "RUM/RUM 会话回放", "description": "查询 RUM 会话的回放元数据与录制分段。" }, { @@ -856,7 +856,7 @@ "summary": "获取故障时间线", "description": "获取指定故障的时间线动态，包括状态变更、评论和系统事件。", "tags": [ - "On-call/Incidents" + "On-call/故障管理" ], "x-mint": { "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **故障查看**（`on-call`） |\n\n## 使用说明\n\n- 对于 `i_comm` 条目，`detail.comment_type` 在读取时根据当前账户级评论类型定义解析，因此始终反映类型的最新名称和颜色。", @@ -1891,7 +1891,7 @@ "summary": "评论故障", "description": "在故障时间线上添加文字评论。", "tags": [ - "On-call/Incidents" + "On-call/故障管理" ], "x-mint": { "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **故障管理**（`on-call`） |\n\n## 使用说明\n\n- 要提及成员，在 `comment` 中嵌入形如 `[@显示名](flashduty://ref/member/)` 的 markdown 链接。被提及的成员会收到专门的个人通知，不受 `mute_reply` 影响。\n- 不带链接语法的纯 `@名字` 文本不会形成提及。\n- 服务端会将每个提及的显示名改写为成员的规范名称。", @@ -11254,7 +11254,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/octet-stream": { "schema": { @@ -11428,7 +11428,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/octet-stream": { "schema": { @@ -11597,7 +11597,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/octet-stream": { "schema": { @@ -11757,7 +11757,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/octet-stream": { "schema": { @@ -12241,7 +12241,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -16497,7 +16497,7 @@ }, "responses": { "200": { - "description": "Success. CSV attachment, not a JSON envelope.", + "description": "成功。CSV 附件，非 JSON 信封。", "headers": { "X-Export-Total": { "description": "Total number of issues matching the filters, before the row cap.", @@ -20613,7 +20613,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -20718,7 +20718,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -20803,7 +20803,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -20879,7 +20879,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -20966,7 +20966,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -21062,7 +21062,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -21173,7 +21173,7 @@ }, "responses": { "200": { - "description": "OK", + "description": "成功", "content": { "application/json": { "schema": { @@ -23092,7 +23092,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -23180,7 +23180,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -23259,7 +23259,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -23338,7 +23338,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -23417,7 +23417,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -23517,7 +23517,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -23624,7 +23624,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -23704,7 +23704,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -23829,7 +23829,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -23908,7 +23908,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -24017,7 +24017,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -24132,7 +24132,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -24231,7 +24231,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -24352,7 +24352,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -24459,7 +24459,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -24547,7 +24547,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -24646,7 +24646,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -24725,7 +24725,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -24804,7 +24804,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -24883,7 +24883,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -24975,7 +24975,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -25074,7 +25074,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -25170,7 +25170,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -25313,7 +25313,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -25462,7 +25462,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -25587,7 +25587,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -25666,7 +25666,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -25745,7 +25745,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -25824,7 +25824,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -25924,7 +25924,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -26029,7 +26029,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -26131,7 +26131,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -26217,7 +26217,7 @@ "summary": "查看会话回放元数据", "description": "返回可回放会话记录的应用、设备、会话时间范围及全部视图信息。", "tags": [ - "RUM/Session replay" + "RUM/RUM 会话回放" ], "x-mint": { "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | 无 —— 持有有效的 `app_key` 即可调用 |\n\n## 使用说明\n\n- 若会话不存在，或该会话没有录制回放数据（`session_has_replay` 为 false），返回 `InvalidParameter`。\n- 若该会话时间窗口内未查询到任何视图，返回 `InvalidParameter`。\n- 当 `session_id` 在不同时间窗口内被复用时，可传入 `ts` 加以区分。", @@ -26317,7 +26317,7 @@ "summary": "查询会话回放分段", "description": "分页获取会话录制的回放分段，可返回预签名下载地址或原始数据流。", "tags": [ - "RUM/Session replay" + "RUM/RUM 会话回放" ], "x-mint": { "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | 无 —— 持有有效的 `app_key` 即可调用 |\n\n## 使用说明\n\n- 当 `url_mode` 为 `false`（默认）时，响应以 `application/x-ndjson` 流式返回——每行是一条解压后的回放分段 JSON 记录——且**不会**包裹在标准信封中；下一页的分页游标改由响应头 `X-Search-After-Ctx` 返回，而非响应体字段。\n- 当 `url_mode` 为 `true` 时，响应为标准 JSON 信封，内含分段的预签名下载地址（1 小时内有效），而非原始字节流。\n- 传入 `ts` 可从该时间点之前最近的一个全量快照分段开始定位，而非从会话起始处分页。\n- `limit` 取值范围 1-99；传入 100 及以上将被拒绝。", @@ -26497,7 +26497,7 @@ "summary": "查询评论类型列表", "description": "获取账户下全部评论类型，按展示位置排序。", "tags": [ - "On-call/Incidents" + "On-call/故障管理" ], "x-mint": { "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **故障查看**（`on-call`） |\n\n## 使用说明\n\n- 一次调用返回完整列表，不分页。\n- 每个账户最多可创建 10 个评论类型。", @@ -26590,7 +26590,7 @@ "summary": "创建评论类型", "description": "创建可附加到故障评论的评论类型。", "tags": [ - "On-call/Incidents" + "On-call/故障管理" ], "x-mint": { "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **评论类型管理**（`on-call`） |\n\n## 使用说明\n\n- 新类型追加到展示顺序的末尾。\n- 名称在账户内必须唯一（不区分大小写，忽略首尾空白）。\n- 每个账户最多可创建 10 个评论类型。\n- 该权限默认仅管理员拥有，自定义角色需显式授予。", @@ -26674,7 +26674,7 @@ "summary": "更新评论类型", "description": "更新已有账户评论类型的名称和/或颜色。", "tags": [ - "On-call/Incidents" + "On-call/故障管理" ], "x-mint": { "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **评论类型管理**（`on-call`） |\n\n## 使用说明\n\n- 部分更新 —— 仅修改提供的字段，但 `name` 和 `color` 至少提供一个。\n- 名称在账户内必须保持唯一（不区分大小写，忽略首尾空白）。\n- 该权限默认仅管理员拥有，自定义角色需显式授予。", @@ -26745,7 +26745,7 @@ "summary": "删除评论类型", "description": "删除评论类型。已使用该类型的评论保留文本内容，但不再显示类型标签。", "tags": [ - "On-call/Incidents" + "On-call/故障管理" ], "x-mint": { "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **评论类型管理**（`on-call`） |\n\n## 使用说明\n\n- 硬删除 —— 评论类型被永久移除，无法恢复。\n- 已引用该类型的评论会失去类型标签，其他内容不受影响。\n- 该权限默认仅管理员拥有，自定义角色需显式授予。", @@ -26815,7 +26815,7 @@ "summary": "调整评论类型顺序", "description": "传入账户全部评论类型 ID 的期望顺序，设置评论类型的展示顺序。", "tags": [ - "On-call/Incidents" + "On-call/故障管理" ], "x-mint": { "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **评论类型管理**（`on-call`） |\n\n## 使用说明\n\n- 全量排序 —— `comment_type_ids` 必须包含账户的全部评论类型，每个恰好出现一次，按期望顺序排列。\n- 展示位置从 1 开始重新分配：数组中的第一个 ID 即为位置 1。\n- 该权限默认仅管理员拥有，自定义角色需显式授予。", @@ -26888,7 +26888,7 @@ "summary": "查询跟进事项列表", "description": "查询故障跟进事项（行动项与复盘后续行动），使用游标分页。", "tags": [ - "On-call/Incidents" + "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` 查询时，须为本人或账户管理员。", @@ -27000,7 +27000,7 @@ "summary": "创建跟进事项", "description": "在活动故障上创建行动项，或在其故障复盘上创建后续行动。", "tags": [ - "On-call/Incidents" + "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- 已审计 —— 变更会记录到审计日志。", @@ -27099,7 +27099,7 @@ "summary": "更新跟进事项", "description": "部分更新跟进事项的标题、描述、状态或优先级。", "tags": [ - "On-call/Incidents" + "On-call/故障管理" ], "x-mint": { "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **故障管理**（`on-call`） |\n\n## 使用说明\n\n- 需要 On-call Pro 许可。\n- 部分更新：未提供的字段保持不变；显式传 `null` 则清空该字段。\n- 乐观锁 —— `version` 必须与事项当前版本一致；不一致返回冲突错误。\n- 负责人、`item_type` 以及故障/复盘锚点不能在此修改 —— 请使用专用接口。\n- 已审计 —— 变更会记录到审计日志。", @@ -27192,7 +27192,7 @@ "summary": "删除跟进事项", "description": "软删除跟进事项。", "tags": [ - "On-call/Incidents" + "On-call/故障管理" ], "x-mint": { "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **故障管理**（`on-call`） |\n\n## 使用说明\n\n- 需要 On-call Pro 许可。\n- 软删除 —— 事项不再出现在列表中，但数据仍保留。\n- 乐观锁 —— `version` 必须与事项当前版本一致；不一致返回冲突错误。\n- 已审计 —— 变更会记录到审计日志。", @@ -27263,7 +27263,7 @@ "summary": "完成跟进事项", "description": "通过设置客户端自定义的目标状态，将跟进事项标记为完成。", "tags": [ - "On-call/Incidents" + "On-call/故障管理" ], "x-mint": { "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **故障管理**（`on-call`） |\n\n## 使用说明\n\n- 需要 On-call Pro 许可。\n- 仅当前负责人可以完成跟进事项。\n- `target_status` 为客户端自定义字符串 —— 没有固定状态机。\n- 相同 `idempotency_key` 搭配相同 `target_status` 会幂等重放；相同键搭配不同 `target_status` 将返回错误。\n- 已审计 —— 变更会记录到审计日志。", @@ -27356,7 +27356,7 @@ "summary": "转化跟进事项为复盘后续行动", "description": "将故障行动项原地转化为故障复盘后续行动。", "tags": [ - "On-call/Incidents" + "On-call/故障管理" ], "x-mint": { "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **故障管理**（`on-call`） |\n\n## 使用说明\n\n- 需要 On-call Pro 许可。\n- 将 `action` 事项原地转化为复盘 `follow_up` —— `work_item_id` 不变。\n- 转化已是 `follow_up` 的事项时返回 `idempotent_replay: true`。\n- 如果故障已存在复盘，转化后的事项会自动绑定到该复盘。\n- 已审计 —— 变更会记录到审计日志。", @@ -27449,7 +27449,7 @@ "summary": "重置跟进事项负责人", "description": "整体替换跟进事项的负责人集合。", "tags": [ - "On-call/Incidents" + "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- 已审计 —— 变更会记录到审计日志。", @@ -27550,7 +27550,7 @@ "summary": "绑定跟进事项到复盘", "description": "将故障下已转化但未绑定的后续行动批量绑定到故障复盘。", "tags": [ - "On-call/Incidents" + "On-call/故障管理" ], "x-mint": { "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **故障管理**（`on-call`） |\n\n## 使用说明\n\n- 需要 On-call Pro 许可。\n- 一次调用将该故障全部已转化但未绑定的后续行动绑定到指定复盘。\n- `items` 为本次新绑定的批次；不设置 `next_cursor` 和 `has_more`。\n- 通过 `idempotency_key` 幂等 —— 以相同键重试时重放原始结果。\n- 已审计 —— 变更会记录到审计日志。", @@ -29995,7 +29995,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -30105,7 +30105,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -30216,7 +30216,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -30308,7 +30308,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -30402,7 +30402,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -30482,7 +30482,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -30581,7 +30581,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -30668,7 +30668,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -30759,7 +30759,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { diff --git a/api-reference/platform.openapi.en.json b/api-reference/platform.openapi.en.json index c6a8e82..1385302 100644 --- a/api-reference/platform.openapi.en.json +++ b/api-reference/platform.openapi.en.json @@ -2228,7 +2228,7 @@ }, "responses": { "200": { - "description": "OK", + "description": "Success", "content": { "application/json": { "schema": { diff --git a/api-reference/platform.openapi.zh.json b/api-reference/platform.openapi.zh.json index b0f0627..4a9bd54 100644 --- a/api-reference/platform.openapi.zh.json +++ b/api-reference/platform.openapi.zh.json @@ -2228,7 +2228,7 @@ }, "responses": { "200": { - "description": "OK", + "description": "成功", "content": { "application/json": { "schema": { diff --git a/api-reference/rum.openapi.zh.json b/api-reference/rum.openapi.zh.json index 4807f25..c4f5263 100644 --- a/api-reference/rum.openapi.zh.json +++ b/api-reference/rum.openapi.zh.json @@ -38,7 +38,7 @@ "description": "管理和查询用于 Browser、Android、iOS 错误符号化的 RUM Sourcemap 文件。" }, { - "name": "RUM/Session replay", + "name": "RUM/RUM 会话回放", "description": "查询 RUM 会话的回放元数据与录制分段。" }, { @@ -869,7 +869,7 @@ }, "responses": { "200": { - "description": "Success. CSV attachment, not a JSON envelope.", + "description": "成功。CSV 附件，非 JSON 信封。", "headers": { "X-Export-Total": { "description": "Total number of issues matching the filters, before the row cap.", @@ -1733,7 +1733,7 @@ "summary": "查看会话回放元数据", "description": "返回可回放会话记录的应用、设备、会话时间范围及全部视图信息。", "tags": [ - "RUM/Session replay" + "RUM/RUM 会话回放" ], "x-mint": { "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | 无 —— 持有有效的 `app_key` 即可调用 |\n\n## 使用说明\n\n- 若会话不存在，或该会话没有录制回放数据（`session_has_replay` 为 false），返回 `InvalidParameter`。\n- 若该会话时间窗口内未查询到任何视图，返回 `InvalidParameter`。\n- 当 `session_id` 在不同时间窗口内被复用时，可传入 `ts` 加以区分。", @@ -1833,7 +1833,7 @@ "summary": "查询会话回放分段", "description": "分页获取会话录制的回放分段，可返回预签名下载地址或原始数据流。", "tags": [ - "RUM/Session replay" + "RUM/RUM 会话回放" ], "x-mint": { "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | 无 —— 持有有效的 `app_key` 即可调用 |\n\n## 使用说明\n\n- 当 `url_mode` 为 `false`（默认）时，响应以 `application/x-ndjson` 流式返回——每行是一条解压后的回放分段 JSON 记录——且**不会**包裹在标准信封中；下一页的分页游标改由响应头 `X-Search-After-Ctx` 返回，而非响应体字段。\n- 当 `url_mode` 为 `true` 时，响应为标准 JSON 信封，内含分段的预签名下载地址（1 小时内有效），而非原始字节流。\n- 传入 `ts` 可从该时间点之前最近的一个全量快照分段开始定位，而非从会话起始处分页。\n- `limit` 取值范围 1-99；传入 100 及以上将被拒绝。", diff --git a/api-reference/safari.openapi.zh.json b/api-reference/safari.openapi.zh.json index fb0fba5..738ed23 100644 --- a/api-reference/safari.openapi.zh.json +++ b/api-reference/safari.openapi.zh.json @@ -63,7 +63,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -151,7 +151,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -230,7 +230,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -309,7 +309,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -388,7 +388,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -488,7 +488,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -595,7 +595,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -675,7 +675,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -800,7 +800,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -879,7 +879,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -988,7 +988,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -1103,7 +1103,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -1202,7 +1202,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -1323,7 +1323,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -1430,7 +1430,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -1518,7 +1518,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -1617,7 +1617,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -1696,7 +1696,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -1775,7 +1775,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -1854,7 +1854,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -1946,7 +1946,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -2045,7 +2045,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -2141,7 +2141,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -2284,7 +2284,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -2433,7 +2433,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -2558,7 +2558,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -2637,7 +2637,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -2716,7 +2716,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -2795,7 +2795,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -2895,7 +2895,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -3000,7 +3000,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -3102,7 +3102,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -3204,7 +3204,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -3314,7 +3314,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -3425,7 +3425,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -3517,7 +3517,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -3611,7 +3611,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -3691,7 +3691,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -3790,7 +3790,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -3877,7 +3877,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": { @@ -3968,7 +3968,7 @@ }, "responses": { "200": { - "description": "Success", + "description": "成功", "content": { "application/json": { "schema": {