Skip to content

Commit 5ba9366

Browse files
authored
Merge pull request #204 from flashcatcloud/automation/api-review-api-20260724-031712
docs(api): sync public API contracts
2 parents 861b45c + 71e4ec1 commit 5ba9366

6 files changed

Lines changed: 152 additions & 16 deletions

File tree

api-reference/monitors.openapi.en.json

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3310,7 +3310,22 @@
33103310
},
33113311
"enabled_times": {
33123312
"type": "array",
3313-
"description": "Time windows when the rule is active.",
3313+
"description": "Time windows when the rule is active. Defaults to all days from 00:00 to 23:59 when omitted or empty.",
3314+
"default": [
3315+
{
3316+
"days": [
3317+
1,
3318+
2,
3319+
3,
3320+
4,
3321+
5,
3322+
6,
3323+
0
3324+
],
3325+
"stime": "00:00",
3326+
"etime": "23:59"
3327+
}
3328+
],
33143329
"items": {
33153330
"type": "object",
33163331
"properties": {
@@ -3343,7 +3358,9 @@
33433358
"enum": [
33443359
"text",
33453360
"markdown"
3346-
]
3361+
],
3362+
"default": "text",
3363+
"description": "Format for the description. Defaults to `text` when omitted or empty."
33473364
},
33483365
"description": {
33493366
"type": "string"

api-reference/monitors.openapi.zh.json

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3310,7 +3310,22 @@
33103310
},
33113311
"enabled_times": {
33123312
"type": "array",
3313-
"description": "规则生效的时间窗口。",
3313+
"description": "规则生效的时间窗口。省略或传空数组时,默认每天 00:00–23:59 生效。",
3314+
"default": [
3315+
{
3316+
"days": [
3317+
1,
3318+
2,
3319+
3,
3320+
4,
3321+
5,
3322+
6,
3323+
0
3324+
],
3325+
"stime": "00:00",
3326+
"etime": "23:59"
3327+
}
3328+
],
33143329
"items": {
33153330
"type": "object",
33163331
"properties": {
@@ -3343,7 +3358,9 @@
33433358
"enum": [
33443359
"text",
33453360
"markdown"
3346-
]
3361+
],
3362+
"default": "text",
3363+
"description": "描述内容的格式。省略或为空时默认使用 `text`。"
33473364
},
33483365
"description": {
33493366
"type": "string"

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

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11996,12 +11996,12 @@
1199611996
"get": {
1199711997
"operationId": "statusPageChangeList",
1199811998
"summary": "List status page events",
11999-
"description": "List events (incidents and maintenances) for a status page.",
11999+
"description": "List status page events with only publicly visible affected components.",
1200012000
"tags": [
1200112001
"On-call/Status pages"
1200212002
],
1200312003
"x-mint": {
12004-
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | None — any valid `app_key` can call this operation |",
12004+
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | None — any valid `app_key` can call this operation |\n\n## Usage\n\n- Hidden affected components are omitted. Events remain in the result when none are visible, with an empty `affected_components` array.",
1200512005
"href": "/en/api-reference/on-call/status-pages/status-page-change-list",
1200612006
"metadata": {
1200712007
"sidebarTitle": "List status page events"
@@ -26301,6 +26301,11 @@
2630126301
"type": "string",
2630226302
"description": "Feishu app message template source."
2630326303
},
26304+
"feishu_app_card_table_enabled": {
26305+
"type": "boolean",
26306+
"default": false,
26307+
"description": "Render alert labels as a table in Feishu app cards."
26308+
},
2630426309
"dingtalk_app": {
2630526310
"type": "string",
2630626311
"description": "DingTalk app message template source."
@@ -26381,6 +26386,7 @@
2638126386
"wecom",
2638226387
"feishu",
2638326388
"feishu_app",
26389+
"feishu_app_card_table_enabled",
2638426390
"dingtalk_app",
2638526391
"wecom_app",
2638626392
"slack_app",
@@ -26447,6 +26453,10 @@
2644726453
"type": "string",
2644826454
"description": "Feishu app message template source."
2644926455
},
26456+
"feishu_app_card_table_enabled": {
26457+
"type": "boolean",
26458+
"description": "Whether alert labels use table rendering in Feishu app cards."
26459+
},
2645026460
"dingtalk_app": {
2645126461
"type": "string",
2645226462
"description": "DingTalk app message template source."
@@ -26657,6 +26667,13 @@
2665726667
"type": "string",
2665826668
"description": "Feishu app message template source."
2665926669
},
26670+
"feishu_app_card_table_enabled": {
26671+
"type": [
26672+
"boolean",
26673+
"null"
26674+
],
26675+
"description": "When set, enable or disable table rendering for alert labels in Feishu app cards. Omit to keep the existing setting."
26676+
},
2666026677
"dingtalk_app": {
2666126678
"type": "string",
2666226679
"description": "DingTalk app message template source."

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

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11988,12 +11988,12 @@
1198811988
"get": {
1198911989
"operationId": "statusPageChangeList",
1199011990
"summary": "查询状态页事件列表",
11991-
"description": "查询状态页的事件列表(故障和维护)。",
11991+
"description": "查询状态页事件列表;响应仅包含对外可见的受影响组件。",
1199211992
"tags": [
1199311993
"On-call/状态页"
1199411994
],
1199511995
"x-mint": {
11996-
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**;**50 次/秒** |\n| 权限要求 | 无 —— 持有有效的 `app_key` 即可调用 |",
11996+
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**;**50 次/秒** |\n| 权限要求 | 无 —— 持有有效的 `app_key` 即可调用 |\n\n## 使用说明\n\n- 响应会过滤隐藏的受影响组件。若事件没有任何可见组件,事件仍会保留,但 `affected_components` 为空数组。",
1199711997
"href": "/zh/api-reference/on-call/status-pages/status-page-change-list",
1199811998
"metadata": {
1199911999
"sidebarTitle": "查询状态页事件列表"
@@ -26292,6 +26292,11 @@
2629226292
"type": "string",
2629326293
"description": "飞书应用消息模板源。"
2629426294
},
26295+
"feishu_app_card_table_enabled": {
26296+
"type": "boolean",
26297+
"default": false,
26298+
"description": "是否在飞书应用卡片中以表格渲染告警标签,默认关闭。"
26299+
},
2629526300
"dingtalk_app": {
2629626301
"type": "string",
2629726302
"description": "钉钉应用消息模板源。"
@@ -26372,6 +26377,7 @@
2637226377
"wecom",
2637326378
"feishu",
2637426379
"feishu_app",
26380+
"feishu_app_card_table_enabled",
2637526381
"dingtalk_app",
2637626382
"wecom_app",
2637726383
"slack_app",
@@ -26438,6 +26444,10 @@
2643826444
"type": "string",
2643926445
"description": "飞书应用消息模板源。"
2644026446
},
26447+
"feishu_app_card_table_enabled": {
26448+
"type": "boolean",
26449+
"description": "是否在飞书应用卡片中以表格渲染告警标签。"
26450+
},
2644126451
"dingtalk_app": {
2644226452
"type": "string",
2644326453
"description": "钉钉应用消息模板源。"
@@ -26648,6 +26658,13 @@
2664826658
"type": "string",
2664926659
"description": "飞书应用消息模板源。"
2665026660
},
26661+
"feishu_app_card_table_enabled": {
26662+
"type": [
26663+
"boolean",
26664+
"null"
26665+
],
26666+
"description": "设置后开启或关闭飞书应用卡片中的告警标签表格渲染;省略时保持当前设置。"
26667+
},
2665126668
"dingtalk_app": {
2665226669
"type": "string",
2665326670
"description": "钉钉应用消息模板源。"

api-reference/openapi.en.json

Lines changed: 38 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11877,12 +11877,12 @@
1187711877
"get": {
1187811878
"operationId": "statusPageChangeList",
1187911879
"summary": "List status page events",
11880-
"description": "List events (incidents and maintenances) for a status page.",
11880+
"description": "List status page events with only publicly visible affected components.",
1188111881
"tags": [
1188211882
"On-call/Status pages"
1188311883
],
1188411884
"x-mint": {
11885-
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | None — any valid `app_key` can call this operation |",
11885+
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | None — any valid `app_key` can call this operation |\n\n## Usage\n\n- Hidden affected components are omitted. Events remain in the result when none are visible, with an empty `affected_components` array.",
1188611886
"href": "/en/api-reference/on-call/status-pages/status-page-change-list",
1188711887
"metadata": {
1188811888
"sidebarTitle": "List status page events"
@@ -34872,6 +34872,7 @@
3487234872
"wecom",
3487334873
"feishu",
3487434874
"feishu_app",
34875+
"feishu_app_card_table_enabled",
3487534876
"dingtalk_app",
3487634877
"wecom_app",
3487734878
"slack_app",
@@ -34938,6 +34939,10 @@
3493834939
"type": "string",
3493934940
"description": "Feishu app message template source."
3494034941
},
34942+
"feishu_app_card_table_enabled": {
34943+
"type": "boolean",
34944+
"description": "Whether alert labels use table rendering in Feishu app cards."
34945+
},
3494134946
"dingtalk_app": {
3494234947
"type": "string",
3494334948
"description": "DingTalk app message template source."
@@ -35156,6 +35161,11 @@
3515635161
"type": "string",
3515735162
"description": "Feishu app message template source."
3515835163
},
35164+
"feishu_app_card_table_enabled": {
35165+
"type": "boolean",
35166+
"default": false,
35167+
"description": "Render alert labels as a table in Feishu app cards."
35168+
},
3515935169
"dingtalk_app": {
3516035170
"type": "string",
3516135171
"description": "DingTalk app message template source."
@@ -35265,6 +35275,13 @@
3526535275
"type": "string",
3526635276
"description": "Feishu app message template source."
3526735277
},
35278+
"feishu_app_card_table_enabled": {
35279+
"type": [
35280+
"boolean",
35281+
"null"
35282+
],
35283+
"description": "When set, enable or disable table rendering for alert labels in Feishu app cards. Omit to keep the existing setting."
35284+
},
3526835285
"dingtalk_app": {
3526935286
"type": "string",
3527035287
"description": "DingTalk app message template source."
@@ -38369,7 +38386,22 @@
3836938386
},
3837038387
"enabled_times": {
3837138388
"type": "array",
38372-
"description": "Time windows when the rule is active.",
38389+
"description": "Time windows when the rule is active. Defaults to all days from 00:00 to 23:59 when omitted or empty.",
38390+
"default": [
38391+
{
38392+
"days": [
38393+
1,
38394+
2,
38395+
3,
38396+
4,
38397+
5,
38398+
6,
38399+
0
38400+
],
38401+
"stime": "00:00",
38402+
"etime": "23:59"
38403+
}
38404+
],
3837338405
"items": {
3837438406
"type": "object",
3837538407
"properties": {
@@ -38402,7 +38434,9 @@
3840238434
"enum": [
3840338435
"text",
3840438436
"markdown"
38405-
]
38437+
],
38438+
"default": "text",
38439+
"description": "Format for the description. Defaults to `text` when omitted or empty."
3840638440
},
3840738441
"description": {
3840838442
"type": "string"

api-reference/openapi.zh.json

Lines changed: 38 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11869,12 +11869,12 @@
1186911869
"get": {
1187011870
"operationId": "statusPageChangeList",
1187111871
"summary": "查询状态页事件列表",
11872-
"description": "查询状态页的事件列表(故障和维护)。",
11872+
"description": "查询状态页事件列表;响应仅包含对外可见的受影响组件。",
1187311873
"tags": [
1187411874
"On-call/状态页"
1187511875
],
1187611876
"x-mint": {
11877-
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**;**50 次/秒** |\n| 权限要求 | 无 —— 持有有效的 `app_key` 即可调用 |",
11877+
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**;**50 次/秒** |\n| 权限要求 | 无 —— 持有有效的 `app_key` 即可调用 |\n\n## 使用说明\n\n- 响应会过滤隐藏的受影响组件。若事件没有任何可见组件,事件仍会保留,但 `affected_components` 为空数组。",
1187811878
"href": "/zh/api-reference/on-call/status-pages/status-page-change-list",
1187911879
"metadata": {
1188011880
"sidebarTitle": "查询状态页事件列表"
@@ -34863,6 +34863,7 @@
3486334863
"wecom",
3486434864
"feishu",
3486534865
"feishu_app",
34866+
"feishu_app_card_table_enabled",
3486634867
"dingtalk_app",
3486734868
"wecom_app",
3486834869
"slack_app",
@@ -34929,6 +34930,10 @@
3492934930
"type": "string",
3493034931
"description": "飞书应用消息模板源。"
3493134932
},
34933+
"feishu_app_card_table_enabled": {
34934+
"type": "boolean",
34935+
"description": "是否在飞书应用卡片中以表格渲染告警标签。"
34936+
},
3493234937
"dingtalk_app": {
3493334938
"type": "string",
3493434939
"description": "钉钉应用消息模板源。"
@@ -35147,6 +35152,11 @@
3514735152
"type": "string",
3514835153
"description": "飞书应用消息模板源。"
3514935154
},
35155+
"feishu_app_card_table_enabled": {
35156+
"type": "boolean",
35157+
"default": false,
35158+
"description": "是否在飞书应用卡片中以表格渲染告警标签,默认关闭。"
35159+
},
3515035160
"dingtalk_app": {
3515135161
"type": "string",
3515235162
"description": "钉钉应用消息模板源。"
@@ -35256,6 +35266,13 @@
3525635266
"type": "string",
3525735267
"description": "飞书应用消息模板源。"
3525835268
},
35269+
"feishu_app_card_table_enabled": {
35270+
"type": [
35271+
"boolean",
35272+
"null"
35273+
],
35274+
"description": "设置后开启或关闭飞书应用卡片中的告警标签表格渲染;省略时保持当前设置。"
35275+
},
3525935276
"dingtalk_app": {
3526035277
"type": "string",
3526135278
"description": "钉钉应用消息模板源。"
@@ -38360,7 +38377,22 @@
3836038377
},
3836138378
"enabled_times": {
3836238379
"type": "array",
38363-
"description": "规则生效的时间窗口。",
38380+
"description": "规则生效的时间窗口。省略或传空数组时,默认每天 00:00–23:59 生效。",
38381+
"default": [
38382+
{
38383+
"days": [
38384+
1,
38385+
2,
38386+
3,
38387+
4,
38388+
5,
38389+
6,
38390+
0
38391+
],
38392+
"stime": "00:00",
38393+
"etime": "23:59"
38394+
}
38395+
],
3836438396
"items": {
3836538397
"type": "object",
3836638398
"properties": {
@@ -38393,7 +38425,9 @@
3839338425
"enum": [
3839438426
"text",
3839538427
"markdown"
38396-
]
38428+
],
38429+
"default": "text",
38430+
"description": "描述内容的格式。省略或为空时默认使用 `text`。"
3839738431
},
3839838432
"description": {
3839938433
"type": "string"

0 commit comments

Comments
 (0)