Skip to content

docs(api): api-review daily audit 2026-09-01 — localize english text in ZH specs (336 ops, zero surface change) #333

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
Sep 1, 2026
Merged

docs(api): api-review daily audit 2026-09-01 — localize english text in ZH specs (336 ops, zero surface change) #333

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
52 changes: 26 additions & 26 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 @@ -896,7 +896,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/octet-stream": {
"schema": {
Expand Down Expand Up @@ -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` 在读取时根据当前账户级评论类型定义解析，因此始终反映类型的最新名称和颜色。",
Expand Down Expand Up @@ -4177,7 +4177,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/octet-stream": {
"schema": {
Expand Down Expand Up @@ -5762,7 +5762,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/octet-stream": {
"schema": {
Expand Down Expand Up @@ -8611,7 +8611,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/octet-stream": {
"schema": {
Expand Down Expand Up @@ -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/<member_id>)` 的 markdown 链接。被提及的成员会收到专门的个人通知，不受 `mute_reply` 影响。\n- 不带链接语法的纯 `@名字` 文本不会形成提及。\n- 服务端会将每个提及的显示名改写为成员的规范名称。",
Expand Down Expand Up @@ -12327,7 +12327,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -13708,7 +13708,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -13813,7 +13813,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -13898,7 +13898,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -13974,7 +13974,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -14061,7 +14061,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -14157,7 +14157,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -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 个评论类型。",
Expand Down Expand Up @@ -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- 该权限默认仅管理员拥有，自定义角色需显式授予。",
Expand Down Expand Up @@ -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- 该权限默认仅管理员拥有，自定义角色需显式授予。",
Expand Down Expand Up @@ -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- 该权限默认仅管理员拥有，自定义角色需显式授予。",
Expand Down Expand Up @@ -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- 该权限默认仅管理员拥有，自定义角色需显式授予。",
Expand Down Expand Up @@ -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` 查询时，须为本人或账户管理员。",
Expand Down Expand Up @@ -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- 已审计 —— 变更会记录到审计日志。",
Expand Down Expand Up @@ -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- 已审计 —— 变更会记录到审计日志。",
Expand Down Expand Up @@ -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- 已审计 —— 变更会记录到审计日志。",
Expand Down Expand Up @@ -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- 已审计 —— 变更会记录到审计日志。",
Expand Down Expand Up @@ -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- 已审计 —— 变更会记录到审计日志。",
Expand Down Expand Up @@ -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- 已审计 —— 变更会记录到审计日志。",
Expand Down Expand Up @@ -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- 已审计 —— 变更会记录到审计日志。",
Expand Down
2 changes: 1 addition & 1 deletion api-reference/openapi.en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21173,7 +21173,7 @@
},
"responses": {
"200": {
"description": "OK",
"description": "Success",
"content": {
"application/json": {
"schema": {
Expand Down
Loading
Loading