From 2ef929e88f2b2be4979166dccd003d59727f133a Mon Sep 17 00:00:00 2001 From: Flashduty AI-SRE Date: Tue, 6 Oct 2026 08:17:59 +0000 Subject: [PATCH] =?UTF-8?q?docs(api):=20daily=20audit=202026-10-06=20?= =?UTF-8?q?=E2=80=94=20localize=20the=20remaining=20English=20text=20in=20?= =?UTF-8?q?the=20zh=20specs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- api-reference/on-call.openapi.zh.json | 32 ++++++++-------- api-reference/openapi.zh.json | 54 +++++++++++++-------------- api-reference/rum.openapi.zh.json | 8 ++-- api-reference/safari.openapi.zh.json | 26 ++++++------- 4 files changed, 60 insertions(+), 60 deletions(-) diff --git a/api-reference/on-call.openapi.zh.json b/api-reference/on-call.openapi.zh.json index 7584560d..c2f86406 100644 --- a/api-reference/on-call.openapi.zh.json +++ b/api-reference/on-call.openapi.zh.json @@ -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。" } ] } @@ -1889,7 +1889,7 @@ "type": "integer", "format": "int64" }, - "description": "Status page ID." + "description": "状态页 ID。" }, { "name": "change_id", @@ -1899,7 +1899,7 @@ "type": "integer", "format": "int64" }, - "description": "Event (change) ID." + "description": "事件（变更）ID。" } ] } @@ -7370,7 +7370,7 @@ "type": "integer", "format": "int64" }, - "description": "Status page ID." + "description": "状态页 ID。" }, { "name": "component_ids", @@ -7379,7 +7379,7 @@ "schema": { "type": "string" }, - "description": "Comma-separated component IDs to filter subscribers by." + "description": "用于筛选订阅者的组件 ID，多个以英文逗号分隔。" }, { "name": "p", @@ -7391,7 +7391,7 @@ "minimum": 1, "default": 1 }, - "description": "Page number (1-based)." + "description": "页码（从 1 开始）。" }, { "name": "limit", @@ -7404,7 +7404,7 @@ "maximum": 100, "default": 10 }, - "description": "Page size (1-100)." + "description": "每页条数（1-100）。" } ] } @@ -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 集合推导出的确定性哈希值。" } ] } @@ -12873,7 +12873,7 @@ "type": "integer", "format": "int64" }, - "description": "Status page ID." + "description": "状态页 ID。" }, { "name": "start_at_seconds", @@ -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", @@ -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", @@ -12906,7 +12906,7 @@ "maintenance" ] }, - "description": "Event type filter. Required." + "description": "事件类型筛选条件。必填。" }, { "name": "status", @@ -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`）。" } ] } @@ -16031,7 +16031,7 @@ "type": "integer", "format": "int64" }, - "description": "Status page ID." + "description": "状态页 ID。" } ] } @@ -16791,7 +16791,7 @@ "type": "integer", "format": "int64" }, - "description": "Status page ID." + "description": "状态页 ID。" }, { "name": "type", @@ -16804,7 +16804,7 @@ "message" ] }, - "description": "Template category. `pre_defined` returns predefined event templates; `message` returns message notification templates." + "description": "模板类别。`pre_defined` 返回预定义事件模板；`message` 返回消息通知模板。" } ] } diff --git a/api-reference/openapi.zh.json b/api-reference/openapi.zh.json index 171481aa..576a5095 100644 --- a/api-reference/openapi.zh.json +++ b/api-reference/openapi.zh.json @@ -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。" @@ -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, @@ -52383,7 +52383,7 @@ "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" } } @@ -52391,14 +52391,14 @@ "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" } @@ -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" } } @@ -54013,7 +54013,7 @@ { "properties": { "data": { - "description": "Always null on success.", + "description": "成功时恒为 null。", "type": "null" } }, @@ -54092,7 +54092,7 @@ { "properties": { "data": { - "description": "Always null on success.", + "description": "成功时恒为 null。", "type": "null" } }, @@ -54171,7 +54171,7 @@ { "properties": { "data": { - "description": "Always null on success.", + "description": "成功时恒为 null。", "type": "null" } }, @@ -54458,7 +54458,7 @@ { "properties": { "data": { - "description": "Always null on success.", + "description": "成功时恒为 null。", "type": "null" } }, @@ -54537,7 +54537,7 @@ { "properties": { "data": { - "description": "Always null on success.", + "description": "成功时恒为 null。", "type": "null" } }, @@ -55080,7 +55080,7 @@ { "properties": { "data": { - "description": "Always null on success.", + "description": "成功时恒为 null。", "type": "null" } }, @@ -60758,7 +60758,7 @@ "operationId": "statusPageChangeInfo", "parameters": [ { - "description": "Status page ID.", + "description": "状态页 ID。", "in": "query", "name": "page_id", "required": true, @@ -60768,7 +60768,7 @@ } }, { - "description": "Event (change) ID.", + "description": "事件（变更）ID。", "in": "query", "name": "change_id", "required": true, @@ -60885,7 +60885,7 @@ "operationId": "statusPageChangeList", "parameters": [ { - "description": "Status page ID.", + "description": "状态页 ID。", "in": "query", "name": "page_id", "required": true, @@ -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, @@ -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, @@ -60915,7 +60915,7 @@ } }, { - "description": "Event type filter. Required.", + "description": "事件类型筛选条件。必填。", "in": "query", "name": "type", "required": true, @@ -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, @@ -61746,7 +61746,7 @@ "operationId": "statusPageInfo", "parameters": [ { - "description": "Status page ID.", + "description": "状态页 ID。", "in": "query", "name": "page_id", "required": true, @@ -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, @@ -62562,7 +62562,7 @@ "operationId": "statusPageSubscriberList", "parameters": [ { - "description": "Status page ID.", + "description": "状态页 ID。", "in": "query", "name": "page_id", "required": true, @@ -62572,7 +62572,7 @@ } }, { - "description": "Comma-separated component IDs to filter subscribers by.", + "description": "用于筛选订阅者的组件 ID，多个以英文逗号分隔。", "in": "query", "name": "component_ids", "required": false, @@ -62581,7 +62581,7 @@ } }, { - "description": "Page number (1-based).", + "description": "页码（从 1 开始）。", "in": "query", "name": "p", "required": false, @@ -62593,7 +62593,7 @@ } }, { - "description": "Page size (1-100).", + "description": "每页条数（1-100）。", "in": "query", "name": "limit", "required": false, @@ -62756,7 +62756,7 @@ "operationId": "statusPageTemplateList", "parameters": [ { - "description": "Status page ID.", + "description": "状态页 ID。", "in": "query", "name": "page_id", "required": true, @@ -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, diff --git a/api-reference/rum.openapi.zh.json b/api-reference/rum.openapi.zh.json index 4cede49f..f447f52f 100644 --- a/api-reference/rum.openapi.zh.json +++ b/api-reference/rum.openapi.zh.json @@ -6321,7 +6321,7 @@ "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" } } @@ -6329,14 +6329,14 @@ "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" } @@ -7789,7 +7789,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" } } diff --git a/api-reference/safari.openapi.zh.json b/api-reference/safari.openapi.zh.json index 166c9cdd..c17d8252 100644 --- a/api-reference/safari.openapi.zh.json +++ b/api-reference/safari.openapi.zh.json @@ -168,7 +168,7 @@ "properties": { "data": { "type": "null", - "description": "Always null on success." + "description": "成功时恒为 null。" } } } @@ -247,7 +247,7 @@ "properties": { "data": { "type": "null", - "description": "Always null on success." + "description": "成功时恒为 null。" } } } @@ -326,7 +326,7 @@ "properties": { "data": { "type": "null", - "description": "Always null on success." + "description": "成功时恒为 null。" } } } @@ -612,7 +612,7 @@ "properties": { "data": { "type": "null", - "description": "Always null on success." + "description": "成功时恒为 null。" } } } @@ -4717,7 +4717,7 @@ "properties": { "data": { "type": "null", - "description": "Always null on success." + "description": "成功时恒为 null。" } } } @@ -4955,7 +4955,7 @@ "properties": { "data": { "type": "null", - "description": "Always null on success." + "description": "成功时恒为 null。" } } } @@ -4990,7 +4990,7 @@ "type": "apiKey", "in": "query", "name": "app_key", - "description": "App key issued from the Flashduty console. Required on every public API call. Keep it secret — it grants the same access as the owning account." + "description": "在 Flashduty 控制台 账户 → APP Key 中签发的 app_key。调用任何公开 API 时都必须携带。它等同于所属账户的身份凭证，请妥善保管。" }, "AutomationTriggerBearerAuth": { "type": "http", @@ -5000,7 +5000,7 @@ }, "responses": { "BadRequest": { - "description": "Invalid request — usually a missing or malformed parameter.", + "description": "请求非法 — 通常是参数缺失或格式不正确。", "content": { "application/json": { "schema": { @@ -5022,7 +5022,7 @@ } }, "Unauthorized": { - "description": "Missing or invalid app_key.", + "description": "app_key 缺失或无效。", "content": { "application/json": { "schema": { @@ -5043,7 +5043,7 @@ } }, "Forbidden": { - "description": "The app_key is valid but lacks permission for this operation.", + "description": "app_key 有效但没有执行该操作的权限。", "content": { "application/json": { "schema": { @@ -5064,7 +5064,7 @@ } }, "TooManyRequests": { - "description": "Rate limit hit. Either the global API limit or a per-account limit.", + "description": "命中限流。可能是全局 API 限流或账户级限流。", "content": { "application/json": { "schema": { @@ -5085,7 +5085,7 @@ } }, "ServerError": { - "description": "Unexpected server-side error. Include the request_id when reporting.", + "description": "服务端未预期错误。反馈问题时请携带 request_id。", "content": { "application/json": { "schema": { @@ -7146,7 +7146,7 @@ }, "ResponseEnvelope": { "type": "object", - "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": { "request_id": { "type": "string",