Skip to content

api-review daily audit 2026-09-07: zh 200 descriptions, tools/invoke restrictions, api-catalog sync #357

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

api-review daily audit 2026-09-07: zh 200 descriptions, tools/invoke restrictions, api-catalog sync #357

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
2 changes: 1 addition & 1 deletion api-reference/monitors.openapi.en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3860,7 +3860,7 @@
"Monitors/Data sources"
],
"x-mint": {
"content": "Use datasource IDs from `/monit/datasource/list`. Disabled datasources return `datasource_disabled`; `alerting_enabled=false` does not block tools. Errors use non-2xx HTTP status and `error.code`, `error.message`, `error.reason`. `tool_not_supported` indicates the selected executor does not provide this tool; it is not a vendor permission error. Never retry through another Edge or the legacy diagnose endpoint automatically.",
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **2,000 requests/minute**; **32 requests/second** per account |\n| Permissions | **Datasources Read** (`monit`) |\n\nUse datasource IDs from `/monit/datasource/list`. Disabled datasources return `datasource_disabled`; `alerting_enabled=false` does not block tools. Errors use non-2xx HTTP status and `error.code`, `error.message`, `error.reason`. `tool_not_supported` indicates the selected executor does not provide this tool; it is not a vendor permission error. Never retry through another Edge or the legacy diagnose endpoint automatically.",
"href": "/en/api-reference/monitors/data-sources/monit-datasource-tools-invoke",
"metadata": {
"sidebarTitle": "Invoke datasource tool"
Expand Down
2 changes: 1 addition & 1 deletion api-reference/monitors.openapi.zh.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3860,7 +3860,7 @@
"Monitors/告警数据源"
],
"x-mint": {
"content": "通过 `/monit/datasource/list` 获取数据源 ID。停用数据源返回 `datasource_disabled`，`alerting_enabled=false` 不阻断工具。错误使用非 2xx HTTP 状态和 `error.code`、`error.message`、`error.reason`。`tool_not_supported` 表示选中的执行端未提供该工具，不表示厂商权限不足。禁止自动切换 Edge 或回退旧 diagnose 重试。",
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **2,000 次/分钟**；**32 次/秒** |\n| 权限要求 | **数据源查看**（`monit`） |\n\n通过 `/monit/datasource/list` 获取数据源 ID。停用数据源返回 `datasource_disabled`，`alerting_enabled=false` 不阻断工具。错误使用非 2xx HTTP 状态和 `error.code`、`error.message`、`error.reason`。`tool_not_supported` 表示选中的执行端未提供该工具，不表示厂商权限不足。禁止自动切换 Edge 或回退旧 diagnose 重试。",
"href": "/zh/api-reference/monitors/data-sources/monit-datasource-tools-invoke",
"metadata": {
"sidebarTitle": "调用数据源工具"
Expand Down
2 changes: 1 addition & 1 deletion api-reference/on-call.openapi.zh.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17340,7 +17340,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
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 @@ -44827,7 +44827,7 @@
"Monitors/Data sources"
],
"x-mint": {
"content": "Use datasource IDs from `/monit/datasource/list`. Disabled datasources return `datasource_disabled`; `alerting_enabled=false` does not block tools. Errors use non-2xx HTTP status and `error.code`, `error.message`, `error.reason`. `tool_not_supported` indicates the selected executor does not provide this tool; it is not a vendor permission error. Never retry through another Edge or the legacy diagnose endpoint automatically.",
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **2,000 requests/minute**; **32 requests/second** per account |\n| Permissions | **Datasources Read** (`monit`) |\n\nUse datasource IDs from `/monit/datasource/list`. Disabled datasources return `datasource_disabled`; `alerting_enabled=false` does not block tools. Errors use non-2xx HTTP status and `error.code`, `error.message`, `error.reason`. `tool_not_supported` indicates the selected executor does not provide this tool; it is not a vendor permission error. Never retry through another Edge or the legacy diagnose endpoint automatically.",
"href": "/en/api-reference/monitors/data-sources/monit-datasource-tools-invoke",
"metadata": {
"sidebarTitle": "Invoke datasource tool"
Expand Down
34 changes: 17 additions & 17 deletions api-reference/openapi.zh.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44827,7 +44827,7 @@
"Monitors/告警数据源"
],
"x-mint": {
"content": "通过 `/monit/datasource/list` 获取数据源 ID。停用数据源返回 `datasource_disabled`，`alerting_enabled=false` 不阻断工具。错误使用非 2xx HTTP 状态和 `error.code`、`error.message`、`error.reason`。`tool_not_supported` 表示选中的执行端未提供该工具，不表示厂商权限不足。禁止自动切换 Edge 或回退旧 diagnose 重试。",
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **2,000 次/分钟**；**32 次/秒** |\n| 权限要求 | **数据源查看**（`monit`） |\n\n通过 `/monit/datasource/list` 获取数据源 ID。停用数据源返回 `datasource_disabled`，`alerting_enabled=false` 不阻断工具。错误使用非 2xx HTTP 状态和 `error.code`、`error.message`、`error.reason`。`tool_not_supported` 表示选中的执行端未提供该工具，不表示厂商权限不足。禁止自动切换 Edge 或回退旧 diagnose 重试。",
"href": "/zh/api-reference/monitors/data-sources/monit-datasource-tools-invoke",
"metadata": {
"sidebarTitle": "调用数据源工具"
Expand Down Expand Up @@ -49939,7 +49939,7 @@
}
}
},
"description": "Success"
"description": "成功"
},
"400": {
"$ref": "#/components/responses/BadRequest"
Expand Down Expand Up @@ -50090,7 +50090,7 @@
}
}
},
"description": "Success"
"description": "成功"
},
"400": {
"$ref": "#/components/responses/BadRequest"
Expand Down Expand Up @@ -50164,7 +50164,7 @@
}
}
},
"description": "Success"
"description": "成功"
},
"400": {
"$ref": "#/components/responses/BadRequest"
Expand Down Expand Up @@ -50244,7 +50244,7 @@
}
}
},
"description": "Success"
"description": "成功"
},
"400": {
"$ref": "#/components/responses/BadRequest"
Expand Down Expand Up @@ -50345,7 +50345,7 @@
}
}
},
"description": "Success"
"description": "成功"
},
"400": {
"$ref": "#/components/responses/BadRequest"
Expand Down Expand Up @@ -53745,7 +53745,7 @@
}
}
},
"description": "Success"
"description": "成功"
},
"400": {
"$ref": "#/components/responses/BadRequest"
Expand Down Expand Up @@ -53832,7 +53832,7 @@
}
}
},
"description": "Success"
"description": "成功"
},
"400": {
"$ref": "#/components/responses/BadRequest"
Expand Down Expand Up @@ -53929,7 +53929,7 @@
}
}
},
"description": "Success"
"description": "成功"
},
"400": {
"$ref": "#/components/responses/BadRequest"
Expand Down Expand Up @@ -54051,7 +54051,7 @@
}
}
},
"description": "Success"
"description": "成功"
},
"400": {
"$ref": "#/components/responses/BadRequest"
Expand Down Expand Up @@ -54131,7 +54131,7 @@
}
}
},
"description": "Success"
"description": "成功"
},
"400": {
"$ref": "#/components/responses/BadRequest"
Expand Down Expand Up @@ -54212,7 +54212,7 @@
}
}
},
"description": "Success"
"description": "成功"
},
"400": {
"$ref": "#/components/responses/BadRequest"
Expand Down Expand Up @@ -54288,7 +54288,7 @@
}
}
},
"description": "Success"
"description": "成功"
},
"400": {
"$ref": "#/components/responses/BadRequest"
Expand Down Expand Up @@ -54369,7 +54369,7 @@
}
}
},
"description": "Success"
"description": "成功"
},
"400": {
"$ref": "#/components/responses/BadRequest"
Expand Down Expand Up @@ -54467,7 +54467,7 @@
}
}
},
"description": "Success"
"description": "成功"
},
"400": {
"$ref": "#/components/responses/BadRequest"
Expand Down Expand Up @@ -54549,7 +54549,7 @@
}
}
},
"description": "Success"
"description": "成功"
},
"400": {
"$ref": "#/components/responses/BadRequest"
Expand Down Expand Up @@ -58089,7 +58089,7 @@
}
}
},
"description": "Success"
"description": "成功"
},
"400": {
"$ref": "#/components/responses/BadRequest"
Expand Down
10 changes: 5 additions & 5 deletions api-reference/rum.openapi.zh.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4617,7 +4617,7 @@
}
}
},
"description": "Success"
"description": "成功"
},
"400": {
"$ref": "#/components/responses/BadRequest"
Expand Down Expand Up @@ -4768,7 +4768,7 @@
}
}
},
"description": "Success"
"description": "成功"
},
"400": {
"$ref": "#/components/responses/BadRequest"
Expand Down Expand Up @@ -4842,7 +4842,7 @@
}
}
},
"description": "Success"
"description": "成功"
},
"400": {
"$ref": "#/components/responses/BadRequest"
Expand Down Expand Up @@ -4922,7 +4922,7 @@
}
}
},
"description": "Success"
"description": "成功"
},
"400": {
"$ref": "#/components/responses/BadRequest"
Expand Down Expand Up @@ -5023,7 +5023,7 @@
}
}
},
"description": "Success"
"description": "成功"
},
"400": {
"$ref": "#/components/responses/BadRequest"
Expand Down
20 changes: 10 additions & 10 deletions api-reference/safari.openapi.zh.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4065,7 +4065,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -4185,7 +4185,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -4285,7 +4285,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -4369,7 +4369,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -4527,7 +4527,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -4607,7 +4607,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -4704,7 +4704,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -4780,7 +4780,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -4861,7 +4861,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -4942,7 +4942,7 @@
},
"responses": {
"200": {
"description": "Success",
"description": "成功",
"content": {
"application/json": {
"schema": {
Expand Down
5 changes: 3 additions & 2 deletions en/openapi/api-catalog.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "API Catalog"
description: "Complete list of Flashduty Open API endpoints, organized by product module with links to detailed documentation"
---

Flashduty Open API provides **353** endpoints covering five major modules: On-call, Monitors, RUM, AI SRE, and Platform. All endpoints use unified authentication and request specifications. See [Quick Start](/en/openapi/introduction) for details.
Flashduty Open API provides **354** endpoints covering five major modules: On-call, Monitors, RUM, AI SRE, and Platform. All endpoints use unified authentication and request specifications. See [Quick Start](/en/openapi/introduction) for details.

<Note>
All endpoint URLs use `https://api.flashcat.cloud` as the base, authenticated via APP Key through query string.
Expand Down Expand Up @@ -271,7 +271,7 @@ All endpoint URLs use `https://api.flashcat.cloud` as the base, authenticated vi

</Accordion>

<Accordion title="Monitors (39 endpoints)">
<Accordion title="Monitors (40 endpoints)">

### Alert rules

Expand Down Expand Up @@ -304,6 +304,7 @@ All endpoint URLs use `https://api.flashcat.cloud` as the base, authenticated vi
| POST | [`/monit/datasource/create`](/en/api-reference/monitors/data-sources/monit-datasource-write-create) | Create datasource |
| POST | [`/monit/datasource/update`](/en/api-reference/monitors/data-sources/monit-datasource-write-update) | Update datasource |
| POST | [`/monit/datasource/delete`](/en/api-reference/monitors/data-sources/monit-datasource-write-delete) | Delete datasource |
| POST | [`/monit/datasource/tools/invoke`](/en/api-reference/monitors/data-sources/monit-datasource-tools-invoke) | Invoke datasource tool |
| POST | [`/monit/datasource/sls/projects`](/en/api-reference/monitors/data-sources/monit-datasource-read-sls-projects) | List SLS projects |
| POST | [`/monit/datasource/sls/logstores`](/en/api-reference/monitors/data-sources/monit-datasource-read-sls-logstores) | List SLS logstores |

Expand Down
5 changes: 3 additions & 2 deletions zh/openapi/api-catalog.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "API 目录"
description: "Flashduty Open API 接口完整列表，按产品模块组织并链接到详细文档"
---

Flashduty Open API 提供 **353** 个接口，覆盖 On-call、Monitors、RUM、AI SRE 和平台五个主要模块。所有接口使用统一认证方式和请求规范。详情参见[快速开始](/zh/openapi/introduction)。
Flashduty Open API 提供 **354** 个接口，覆盖 On-call、Monitors、RUM、AI SRE 和平台五个主要模块。所有接口使用统一认证方式和请求规范。详情参见[快速开始](/zh/openapi/introduction)。

<Note>
所有接口 URL 均以 `https://api.flashcat.cloud` 为 base，通过 query string 中的 APP Key 认证。
Expand Down Expand Up @@ -271,7 +271,7 @@ Flashduty Open API 提供 **353** 个接口，覆盖 On-call、Monitors、RUM、

</Accordion>

<Accordion title="Monitors（39 个接口）">
<Accordion title="Monitors（40 个接口）">

### 告警规则

Expand Down Expand Up @@ -304,6 +304,7 @@ Flashduty Open API 提供 **353** 个接口，覆盖 On-call、Monitors、RUM、
| POST | [`/monit/datasource/create`](/zh/api-reference/monitors/data-sources/monit-datasource-write-create) | 创建数据源 |
| POST | [`/monit/datasource/update`](/zh/api-reference/monitors/data-sources/monit-datasource-write-update) | 更新数据源 |
| POST | [`/monit/datasource/delete`](/zh/api-reference/monitors/data-sources/monit-datasource-write-delete) | 删除数据源 |
| POST | [`/monit/datasource/tools/invoke`](/zh/api-reference/monitors/data-sources/monit-datasource-tools-invoke) | 调用数据源工具 |
| POST | [`/monit/datasource/sls/projects`](/zh/api-reference/monitors/data-sources/monit-datasource-read-sls-projects) | 查询 SLS 项目列表 |
| POST | [`/monit/datasource/sls/logstores`](/zh/api-reference/monitors/data-sources/monit-datasource-read-sls-logstores) | 查询 SLS 日志库列表 |

Expand Down
Loading