Skip to content

Commit 1f01cd0

Browse files
authored
Merge pull request #247 from flashcatcloud/feat/api-review-auto-fix-20260806
docs(api): publish ServiceMap and RUM rule endpoints
2 parents d1f4ed7 + 974016d commit 1f01cd0

14 files changed

Lines changed: 54443 additions & 34735 deletions

.agents/skills/api-review/scripts/generate_openapi.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -401,7 +401,9 @@ def rate_limits_cell(lang: str, op: dict | None = None) -> str:
401401
per_s = rl["per_second"]
402402
per_m = rl["per_minute"]
403403
if lang == "en":
404-
return f"**{per_m:,} requests/minute**; **{per_s} requests/second** per account"
404+
noun_m = "request" if per_m == 1 else "requests"
405+
noun_s = "request" if per_s == 1 else "requests"
406+
return f"**{per_m:,} {noun_m}/minute**; **{per_s} {noun_s}/second** per account"
405407
return f"每个账户 **{per_m:,} 次/分钟**;**{per_s} 次/秒**"
406408

407409

api-reference/monitors.openapi.en.json

Lines changed: 3780 additions & 1509 deletions
Large diffs are not rendered by default.

api-reference/monitors.openapi.zh.json

Lines changed: 3780 additions & 1509 deletions
Large diffs are not rendered by default.

api-reference/on-call.openapi.en.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16167,7 +16167,7 @@
1616716167
"On-call/Incidents"
1616816168
],
1616916169
"x-mint": {
16170-
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Incidents Manage** (`on-call`) |\n\n## Usage\n\n- The new type is appended to the end of the display ordering.\n- The name must be unique within the account (case-insensitive, after trimming whitespace).\n- An account can have at most 10 comment types.",
16170+
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Comment Types Manage** (`on-call`) |\n\n## Usage\n\n- The new type is appended to the end of the display ordering.\n- The name must be unique within the account (case-insensitive, after trimming whitespace).\n- An account can have at most 10 comment types.\n- This permission is admin-only by default; custom roles must be granted it explicitly.",
1617116171
"href": "/en/api-reference/on-call/incidents/incident-comment-type-create",
1617216172
"metadata": {
1617316173
"sidebarTitle": "Create a comment type"
@@ -16251,7 +16251,7 @@
1625116251
"On-call/Incidents"
1625216252
],
1625316253
"x-mint": {
16254-
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Incidents Manage** (`on-call`) |\n\n## Usage\n\n- Partial update — only the provided fields are changed, but at least one of `name` or `color` must be provided.\n- The name must remain unique within the account (case-insensitive, after trimming whitespace).",
16254+
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Comment Types Manage** (`on-call`) |\n\n## Usage\n\n- Partial update — only the provided fields are changed, but at least one of `name` or `color` must be provided.\n- The name must remain unique within the account (case-insensitive, after trimming whitespace).\n- This permission is admin-only by default; custom roles must be granted it explicitly.",
1625516255
"href": "/en/api-reference/on-call/incidents/incident-comment-type-update",
1625616256
"metadata": {
1625716257
"sidebarTitle": "Update a comment type"
@@ -16322,7 +16322,7 @@
1632216322
"On-call/Incidents"
1632316323
],
1632416324
"x-mint": {
16325-
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Incidents Manage** (`on-call`) |\n\n## Usage\n\n- Hard delete — the comment type is removed permanently and cannot be restored.\n- Existing comments that referenced the type lose the type label but are not otherwise affected.",
16325+
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Comment Types Manage** (`on-call`) |\n\n## Usage\n\n- Hard delete — the comment type is removed permanently and cannot be restored.\n- Existing comments that referenced the type lose the type label but are not otherwise affected.\n- This permission is admin-only by default; custom roles must be granted it explicitly.",
1632616326
"href": "/en/api-reference/on-call/incidents/incident-comment-type-delete",
1632716327
"metadata": {
1632816328
"sidebarTitle": "Delete a comment type"
@@ -16392,7 +16392,7 @@
1639216392
"On-call/Incidents"
1639316393
],
1639416394
"x-mint": {
16395-
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Incidents Manage** (`on-call`) |\n\n## Usage\n\n- Full-set reorder — `comment_type_ids` must contain every comment type of the account, each exactly once, in the desired order.\n- Positions are reassigned starting from 1: the first ID in the array becomes position 1.",
16395+
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Comment Types Manage** (`on-call`) |\n\n## Usage\n\n- Full-set reorder — `comment_type_ids` must contain every comment type of the account, each exactly once, in the desired order.\n- Positions are reassigned starting from 1: the first ID in the array becomes position 1.\n- This permission is admin-only by default; custom roles must be granted it explicitly.",
1639616396
"href": "/en/api-reference/on-call/incidents/incident-comment-type-reorder",
1639716397
"metadata": {
1639816398
"sidebarTitle": "Reorder comment types"
@@ -16465,7 +16465,7 @@
1646516465
"On-call/Incidents"
1646616466
],
1646716467
"x-mint": {
16468-
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Incidents Read** (`on-call`) |\n\n## Usage\n\n- Requires the On-call Pro license.\n- At least one of `incident_id`, `post_mortem_id`, or `assignee_id` is required.\n- Cursor pagination sorted by `updated_at_seconds` descending — pass the previous response's `next_cursor` as `cursor` until `has_more` is false.\n- Listing by `incident_id` also includes follow-ups anchored on the incident's post-mortem.\n- Listing by `assignee_id` alone requires being that assignee or an account admin.",
16468+
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Incidents Read** (`on-call`) |\n\n## Usage\n\n- At least one of `incident_id`, `post_mortem_id`, or `assignee_id` is required.\n- Cursor pagination sorted by `updated_at_seconds` descending — pass the previous response's `next_cursor` as `cursor` until `has_more` is false.\n- Listing by `incident_id` also includes follow-ups anchored on the incident's post-mortem.\n- Listing by `assignee_id` alone requires being that assignee or an account admin.",
1646916469
"href": "/en/api-reference/on-call/incidents/incident-work-item-list",
1647016470
"metadata": {
1647116471
"sidebarTitle": "List work items"

api-reference/on-call.openapi.zh.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16159,7 +16159,7 @@
1615916159
"On-call/Incidents"
1616016160
],
1616116161
"x-mint": {
16162-
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**;**50 次/秒** |\n| 权限要求 | **故障管理**(`on-call`) |\n\n## 使用说明\n\n- 新类型追加到展示顺序的末尾。\n- 名称在账户内必须唯一(不区分大小写,忽略首尾空白)。\n- 每个账户最多可创建 10 个评论类型。",
16162+
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**;**50 次/秒** |\n| 权限要求 | **评论类型管理**(`on-call`) |\n\n## 使用说明\n\n- 新类型追加到展示顺序的末尾。\n- 名称在账户内必须唯一(不区分大小写,忽略首尾空白)。\n- 每个账户最多可创建 10 个评论类型。\n- 该权限默认仅管理员拥有,自定义角色需显式授予。",
1616316163
"href": "/zh/api-reference/on-call/incidents/incident-comment-type-create",
1616416164
"metadata": {
1616516165
"sidebarTitle": "创建评论类型"
@@ -16243,7 +16243,7 @@
1624316243
"On-call/Incidents"
1624416244
],
1624516245
"x-mint": {
16246-
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**;**50 次/秒** |\n| 权限要求 | **故障管理**(`on-call`) |\n\n## 使用说明\n\n- 部分更新 —— 仅修改提供的字段,但 `name` 和 `color` 至少提供一个。\n- 名称在账户内必须保持唯一(不区分大小写,忽略首尾空白)。",
16246+
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**;**50 次/秒** |\n| 权限要求 | **评论类型管理**(`on-call`) |\n\n## 使用说明\n\n- 部分更新 —— 仅修改提供的字段,但 `name` 和 `color` 至少提供一个。\n- 名称在账户内必须保持唯一(不区分大小写,忽略首尾空白)。\n- 该权限默认仅管理员拥有,自定义角色需显式授予。",
1624716247
"href": "/zh/api-reference/on-call/incidents/incident-comment-type-update",
1624816248
"metadata": {
1624916249
"sidebarTitle": "更新评论类型"
@@ -16314,7 +16314,7 @@
1631416314
"On-call/Incidents"
1631516315
],
1631616316
"x-mint": {
16317-
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**;**50 次/秒** |\n| 权限要求 | **故障管理**(`on-call`) |\n\n## 使用说明\n\n- 硬删除 —— 评论类型被永久移除,无法恢复。\n- 已引用该类型的评论会失去类型标签,其他内容不受影响。",
16317+
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**;**50 次/秒** |\n| 权限要求 | **评论类型管理**(`on-call`) |\n\n## 使用说明\n\n- 硬删除 —— 评论类型被永久移除,无法恢复。\n- 已引用该类型的评论会失去类型标签,其他内容不受影响。\n- 该权限默认仅管理员拥有,自定义角色需显式授予。",
1631816318
"href": "/zh/api-reference/on-call/incidents/incident-comment-type-delete",
1631916319
"metadata": {
1632016320
"sidebarTitle": "删除评论类型"
@@ -16384,7 +16384,7 @@
1638416384
"On-call/Incidents"
1638516385
],
1638616386
"x-mint": {
16387-
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**;**50 次/秒** |\n| 权限要求 | **故障管理**(`on-call`) |\n\n## 使用说明\n\n- 全量排序 —— `comment_type_ids` 必须包含账户的全部评论类型,每个恰好出现一次,按期望顺序排列。\n- 展示位置从 1 开始重新分配:数组中的第一个 ID 即为位置 1。",
16387+
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**;**50 次/秒** |\n| 权限要求 | **评论类型管理**(`on-call`) |\n\n## 使用说明\n\n- 全量排序 —— `comment_type_ids` 必须包含账户的全部评论类型,每个恰好出现一次,按期望顺序排列。\n- 展示位置从 1 开始重新分配:数组中的第一个 ID 即为位置 1。\n- 该权限默认仅管理员拥有,自定义角色需显式授予。",
1638816388
"href": "/zh/api-reference/on-call/incidents/incident-comment-type-reorder",
1638916389
"metadata": {
1639016390
"sidebarTitle": "调整评论类型顺序"
@@ -16457,7 +16457,7 @@
1645716457
"On-call/Incidents"
1645816458
],
1645916459
"x-mint": {
16460-
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**;**50 次/秒** |\n| 权限要求 | **故障查看**(`on-call`) |\n\n## 使用说明\n\n- 需要 On-call Pro 许可。\n- `incident_id`、`post_mortem_id`、`assignee_id` 至少提供一个。\n- 按 `updated_at_seconds` 倒序的游标分页 —— 将上一次响应的 `next_cursor` 作为 `cursor` 传入,直到 `has_more` 为 false。\n- 按 `incident_id` 查询时,同时包含锚定在该故障复盘上的后续行动。\n- 仅按 `assignee_id` 查询时,须为本人或账户管理员。",
16460+
"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` 查询时,须为本人或账户管理员。",
1646116461
"href": "/zh/api-reference/on-call/incidents/incident-work-item-list",
1646216462
"metadata": {
1646316463
"sidebarTitle": "查询跟进事项列表"

0 commit comments

Comments
 (0)