Skip to content

docs(api): daily audit 2026-10-06 — localize the remaining English text in the zh specs #1022

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

docs(api): daily audit 2026-10-06 — localize the remaining English text in the zh specs #1022

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
32 changes: 16 additions & 16 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 @@ -1115,7 +1115,7 @@
"schema": {
"type": "string"
},
"description": "Migration job ID returned by `migrate-structure` or `migrate-email-subscribers`."
"description": "由 `migrate-structure` 或 `migrate-email-subscribers` 返回的迁移任务 ID。"
}
]
}
Expand Down Expand Up @@ -1889,7 +1889,7 @@
"type": "integer",
"format": "int64"
},
"description": "Status page ID."
"description": "状态页 ID。"
},
{
"name": "change_id",
Expand All @@ -1899,7 +1899,7 @@
"type": "integer",
"format": "int64"
},
"description": "Event (change) ID."
"description": "事件（变更）ID。"
}
]
}
Expand Down Expand Up @@ -7370,7 +7370,7 @@
"type": "integer",
"format": "int64"
},
"description": "Status page ID."
"description": "状态页 ID。"
},
{
"name": "component_ids",
Expand All @@ -7379,7 +7379,7 @@
"schema": {
"type": "string"
},
"description": "Comma-separated component IDs to filter subscribers by."
"description": "用于筛选订阅者的组件 ID，多个以英文逗号分隔。"
},
{
"name": "p",
Expand All @@ -7391,7 +7391,7 @@
"minimum": 1,
"default": 1
},
"description": "Page number (1-based)."
"description": "页码（从 1 开始）。"
},
{
"name": "limit",
Expand All @@ -7404,7 +7404,7 @@
"maximum": 100,
"default": 10
},
"description": "Page size (1-100)."
"description": "每页条数（1-100）。"
}
]
}
Expand Down Expand Up @@ -8099,7 +8099,7 @@
"schema": {
"type": "string"
},
"description": "Post-mortem ID. Deterministic hash derived from account ID and the set of linked incident IDs."
"description": "故障复盘 ID。由账户 ID 与关联故障 ID 集合推导出的确定性哈希值。"
}
]
}
Expand Down Expand Up @@ -12873,7 +12873,7 @@
"type": "integer",
"format": "int64"
},
"description": "Status page ID."
"description": "状态页 ID。"
},
{
"name": "start_at_seconds",
Expand All @@ -12883,7 +12883,7 @@
"type": "integer",
"format": "int64"
},
"description": "Lower bound of the event activity window: only events still open at, or closed at or after, this Unix timestamp (seconds) are returned."
"description": "事件活动时间窗的下界：仅返回在该 Unix 时间戳（秒）时仍未结束、或在该时刻之后结束的事件。"
},
{
"name": "end_at_seconds",
Expand All @@ -12893,7 +12893,7 @@
"type": "integer",
"format": "int64"
},
"description": "Upper bound of the event activity window: only events started at or before this Unix timestamp (seconds) are returned."
"description": "事件活动时间窗的上界：仅返回在该 Unix 时间戳（秒）或之前开始的事件。"
},
{
"name": "type",
Expand All @@ -12906,7 +12906,7 @@
"maintenance"
]
},
"description": "Event type filter. Required."
"description": "事件类型筛选条件。必填。"
},
{
"name": "status",
Expand All @@ -12924,7 +12924,7 @@
"completed"
]
},
"description": "Event status filter. Required. Must be a status valid for the given `type` (`investigating`/`identified`/`monitoring`/`resolved` for `incident`; `scheduled`/`ongoing`/`completed` for `maintenance`)."
"description": "事件状态筛选条件。必填。必须是与所给 `type` 匹配的合法状态（`incident` 为 `investigating`/`identified`/`monitoring`/`resolved`；`maintenance` 为 `scheduled`/`ongoing`/`completed`）。"
}
]
}
Expand Down Expand Up @@ -16031,7 +16031,7 @@
"type": "integer",
"format": "int64"
},
"description": "Status page ID."
"description": "状态页 ID。"
}
]
}
Expand Down Expand Up @@ -16791,7 +16791,7 @@
"type": "integer",
"format": "int64"
},
"description": "Status page ID."
"description": "状态页 ID。"
},
{
"name": "type",
Expand All @@ -16804,7 +16804,7 @@
"message"
]
},
"description": "Template category. `pre_defined` returns predefined event templates; `message` returns message notification templates."
"description": "模板类别。`pre_defined` 返回预定义事件模板；`message` 返回消息通知模板。"
}
]
}
Expand Down
54 changes: 27 additions & 27 deletions api-reference/openapi.zh.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18385,7 +18385,7 @@
"type": "object"
},
"ResponseEnvelope": {
"description": "Standard response envelope used by every Flashduty public API. On success `data` contains the endpoint-specific payload and `error` is absent. On failure `error` is present and `data` is absent. `request_id` is always present and is also mirrored in the `Flashcat-Request-Id` response header.",
"description": "所有 Flashduty 公开 API 共用的标准响应结构。成功时 `data` 为接口专属载荷且不含 `error`；失败时 `error` 存在而 `data` 缺失。`request_id` 始终存在，并会同步写入 `Flashcat-Request-Id` 响应头。",
"properties": {
"data": {
"description": "端点专属数据负载，具体结构见各操作 200 响应中的 schema。"
Expand Down Expand Up @@ -42088,7 +42088,7 @@
"operationId": "incidentPostMortemInfo",
"parameters": [
{
"description": "Post-mortem ID. Deterministic hash derived from account ID and the set of linked incident IDs.",
"description": "故障复盘 ID。由账户 ID 与关联故障 ID 集合推导出的确定性哈希值。",
"in": "query",
"name": "post_mortem_id",
"required": true,
Expand Down Expand Up @@ -52383,22 +52383,22 @@
"text/csv": {
"example": "Issue ID,Error type,Error message,Status,Error count,Affected sessions,Last seen (Asia/Shanghai)\nNHEacQHi2DhXqobr9qPQz9,Error,Script error.,for_review,752,381,2026-04-12 10:43:59\nH8kZSmxiE7EgdyD4fCyyNa,Error,\"API ERROR: We encountered an internal error | POST /api/access/logout\",for_review,3,1,2026-04-03 12:41:24",
"schema": {
"description": "CSV file content. The header row matches the exported columns in order; values are sanitized against spreadsheet formula injection.",
"description": "CSV 文件内容。表头行按导出列的先后顺序排列；单元格取值已做电子表格公式注入防护。",
"type": "string"
}
}
},
"description": "成功。CSV 附件，非 JSON 信封。",
"headers": {
"X-Export-Total": {
"description": "Total number of issues matching the filters, before the row cap.",
"description": "符合筛选条件的异常总数，未受行数上限截断前。",
"schema": {
"format": "int64",
"type": "integer"
}
},
"X-Export-Truncated": {
"description": "`true` when more issues matched than the 100-row cap and the file was truncated.",
"description": "当匹配的异常超过 100 行上限、文件被截断时为 `true`。",
"schema": {
"type": "boolean"
}
Expand Down Expand Up @@ -53851,7 +53851,7 @@
},
"application/x-ndjson": {
"schema": {
"description": "Newline-delimited JSON (NDJSON). Each line is one decompressed replay segment record (rrweb-format events), streamed directly and not wrapped in the standard envelope.",
"description": "按行分隔的 JSON（NDJSON）。每一行是一条解压后的回放分片记录（rrweb 格式事件），直接流式返回，不使用标准响应结构包裹。",
"type": "string"
}
}
Expand Down Expand Up @@ -54013,7 +54013,7 @@
{
"properties": {
"data": {
"description": "Always null on success.",
"description": "成功时恒为 null。",
"type": "null"
}
},
Expand Down Expand Up @@ -54092,7 +54092,7 @@
{
"properties": {
"data": {
"description": "Always null on success.",
"description": "成功时恒为 null。",
"type": "null"
}
},
Expand Down Expand Up @@ -54171,7 +54171,7 @@
{
"properties": {
"data": {
"description": "Always null on success.",
"description": "成功时恒为 null。",
"type": "null"
}
},
Expand Down Expand Up @@ -54458,7 +54458,7 @@
{
"properties": {
"data": {
"description": "Always null on success.",
"description": "成功时恒为 null。",
"type": "null"
}
},
Expand Down Expand Up @@ -54537,7 +54537,7 @@
{
"properties": {
"data": {
"description": "Always null on success.",
"description": "成功时恒为 null。",
"type": "null"
}
},
Expand Down Expand Up @@ -55080,7 +55080,7 @@
{
"properties": {
"data": {
"description": "Always null on success.",
"description": "成功时恒为 null。",
"type": "null"
}
},
Expand Down Expand Up @@ -60758,7 +60758,7 @@
"operationId": "statusPageChangeInfo",
"parameters": [
{
"description": "Status page ID.",
"description": "状态页 ID。",
"in": "query",
"name": "page_id",
"required": true,
Expand All @@ -60768,7 +60768,7 @@
}
},
{
"description": "Event (change) ID.",
"description": "事件（变更）ID。",
"in": "query",
"name": "change_id",
"required": true,
Expand Down Expand Up @@ -60885,7 +60885,7 @@
"operationId": "statusPageChangeList",
"parameters": [
{
"description": "Status page ID.",
"description": "状态页 ID。",
"in": "query",
"name": "page_id",
"required": true,
Expand All @@ -60895,7 +60895,7 @@
}
},
{
"description": "Lower bound of the event activity window: only events still open at, or closed at or after, this Unix timestamp (seconds) are returned.",
"description": "事件活动时间窗的下界：仅返回在该 Unix 时间戳（秒）时仍未结束、或在该时刻之后结束的事件。",
"in": "query",
"name": "start_at_seconds",
"required": false,
Expand All @@ -60905,7 +60905,7 @@
}
},
{
"description": "Upper bound of the event activity window: only events started at or before this Unix timestamp (seconds) are returned.",
"description": "事件活动时间窗的上界：仅返回在该 Unix 时间戳（秒）或之前开始的事件。",
"in": "query",
"name": "end_at_seconds",
"required": false,
Expand All @@ -60915,7 +60915,7 @@
}
},
{
"description": "Event type filter. Required.",
"description": "事件类型筛选条件。必填。",
"in": "query",
"name": "type",
"required": true,
Expand All @@ -60928,7 +60928,7 @@
}
},
{
"description": "Event status filter. Required. Must be a status valid for the given `type` (`investigating`/`identified`/`monitoring`/`resolved` for `incident`; `scheduled`/`ongoing`/`completed` for `maintenance`).",
"description": "事件状态筛选条件。必填。必须是与所给 `type` 匹配的合法状态（`incident` 为 `investigating`/`identified`/`monitoring`/`resolved`；`maintenance` 为 `scheduled`/`ongoing`/`completed`）。",
"in": "query",
"name": "status",
"required": true,
Expand Down Expand Up @@ -61746,7 +61746,7 @@
"operationId": "statusPageInfo",
"parameters": [
{
"description": "Status page ID.",
"description": "状态页 ID。",
"in": "query",
"name": "page_id",
"required": true,
Expand Down Expand Up @@ -62179,7 +62179,7 @@
"operationId": "statusPageMigrationStatus",
"parameters": [
{
"description": "Migration job ID returned by `migrate-structure` or `migrate-email-subscribers`.",
"description": "由 `migrate-structure` 或 `migrate-email-subscribers` 返回的迁移任务 ID。",
"in": "query",
"name": "job_id",
"required": true,
Expand Down Expand Up @@ -62562,7 +62562,7 @@
"operationId": "statusPageSubscriberList",
"parameters": [
{
"description": "Status page ID.",
"description": "状态页 ID。",
"in": "query",
"name": "page_id",
"required": true,
Expand All @@ -62572,7 +62572,7 @@
}
},
{
"description": "Comma-separated component IDs to filter subscribers by.",
"description": "用于筛选订阅者的组件 ID，多个以英文逗号分隔。",
"in": "query",
"name": "component_ids",
"required": false,
Expand All @@ -62581,7 +62581,7 @@
}
},
{
"description": "Page number (1-based).",
"description": "页码（从 1 开始）。",
"in": "query",
"name": "p",
"required": false,
Expand All @@ -62593,7 +62593,7 @@
}
},
{
"description": "Page size (1-100).",
"description": "每页条数（1-100）。",
"in": "query",
"name": "limit",
"required": false,
Expand Down Expand Up @@ -62756,7 +62756,7 @@
"operationId": "statusPageTemplateList",
"parameters": [
{
"description": "Status page ID.",
"description": "状态页 ID。",
"in": "query",
"name": "page_id",
"required": true,
Expand All @@ -62766,7 +62766,7 @@
}
},
{
"description": "Template category. `pre_defined` returns predefined event templates; `message` returns message notification templates.",
"description": "模板类别。`pre_defined` 返回预定义事件模板；`message` 返回消息通知模板。",
"in": "query",
"name": "type",
"required": true,
Expand Down
Loading
Loading