Skip to content

chore: sync OpenAPI spec from flashduty-docs #37

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

Open
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: sync OpenAPI spec from flashduty-docs #37

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
12 changes: 10 additions & 2 deletions models_gen.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

42 changes: 38 additions & 4 deletions openapi/openapi.en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11877,12 +11877,12 @@
"get": {
"operationId": "statusPageChangeList",
"summary": "List status page events",
"description": "List events (incidents and maintenances) for a status page.",
"description": "List status page events with only publicly visible affected components.",
"tags": [
"On-call/Status pages"
],
"x-mint": {
"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 |",
"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.",
"href": "/en/api-reference/on-call/status-pages/status-page-change-list",
"metadata": {
"sidebarTitle": "List status page events"
Expand Down Expand Up @@ -34872,6 +34872,7 @@
"wecom",
"feishu",
"feishu_app",
"feishu_app_card_table_enabled",
"dingtalk_app",
"wecom_app",
"slack_app",
Expand Down Expand Up @@ -34938,6 +34939,10 @@
"type": "string",
"description": "Feishu app message template source."
},
"feishu_app_card_table_enabled": {
"type": "boolean",
"description": "Whether alert labels use table rendering in Feishu app cards."
},
"dingtalk_app": {
"type": "string",
"description": "DingTalk app message template source."
Expand Down Expand Up @@ -35156,6 +35161,11 @@
"type": "string",
"description": "Feishu app message template source."
},
"feishu_app_card_table_enabled": {
"type": "boolean",
"default": false,
"description": "Render alert labels as a table in Feishu app cards."
},
"dingtalk_app": {
"type": "string",
"description": "DingTalk app message template source."
Expand Down Expand Up @@ -35265,6 +35275,13 @@
"type": "string",
"description": "Feishu app message template source."
},
"feishu_app_card_table_enabled": {
"type": [
"boolean",
"null"
],
"description": "When set, enable or disable table rendering for alert labels in Feishu app cards. Omit to keep the existing setting."
},
"dingtalk_app": {
"type": "string",
"description": "DingTalk app message template source."
Expand Down Expand Up @@ -38369,7 +38386,22 @@
},
"enabled_times": {
"type": "array",
"description": "Time windows when the rule is active.",
"description": "Time windows when the rule is active. Defaults to all days from 00:00 to 23:59 when omitted or empty.",
"default": [
{
"days": [
1,
2,
3,
4,
5,
6,
0
],
"stime": "00:00",
"etime": "23:59"
}
],
"items": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -38402,7 +38434,9 @@
"enum": [
"text",
"markdown"
]
],
"default": "text",
"description": "Format for the description. Defaults to `text` when omitted or empty."
},
"description": {
"type": "string"
Expand Down
42 changes: 38 additions & 4 deletions openapi/openapi.zh.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11869,12 +11869,12 @@
"get": {
"operationId": "statusPageChangeList",
"summary": "查询状态页事件列表",
"description": "查询状态页的事件列表（故障和维护）。",
"description": "查询状态页事件列表；响应仅包含对外可见的受影响组件。",
"tags": [
"On-call/状态页"
],
"x-mint": {
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | 无 —— 持有有效的 `app_key` 即可调用 |",
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | 无 —— 持有有效的 `app_key` 即可调用 |\n\n## 使用说明\n\n- 响应会过滤隐藏的受影响组件。若事件没有任何可见组件，事件仍会保留，但 `affected_components` 为空数组。",
"href": "/zh/api-reference/on-call/status-pages/status-page-change-list",
"metadata": {
"sidebarTitle": "查询状态页事件列表"
Expand Down Expand Up @@ -34863,6 +34863,7 @@
"wecom",
"feishu",
"feishu_app",
"feishu_app_card_table_enabled",
"dingtalk_app",
"wecom_app",
"slack_app",
Expand Down Expand Up @@ -34929,6 +34930,10 @@
"type": "string",
"description": "飞书应用消息模板源。"
},
"feishu_app_card_table_enabled": {
"type": "boolean",
"description": "是否在飞书应用卡片中以表格渲染告警标签。"
},
"dingtalk_app": {
"type": "string",
"description": "钉钉应用消息模板源。"
Expand Down Expand Up @@ -35147,6 +35152,11 @@
"type": "string",
"description": "飞书应用消息模板源。"
},
"feishu_app_card_table_enabled": {
"type": "boolean",
"default": false,
"description": "是否在飞书应用卡片中以表格渲染告警标签，默认关闭。"
},
"dingtalk_app": {
"type": "string",
"description": "钉钉应用消息模板源。"
Expand Down Expand Up @@ -35256,6 +35266,13 @@
"type": "string",
"description": "飞书应用消息模板源。"
},
"feishu_app_card_table_enabled": {
"type": [
"boolean",
"null"
],
"description": "设置后开启或关闭飞书应用卡片中的告警标签表格渲染；省略时保持当前设置。"
},
"dingtalk_app": {
"type": "string",
"description": "钉钉应用消息模板源。"
Expand Down Expand Up @@ -38360,7 +38377,22 @@
},
"enabled_times": {
"type": "array",
"description": "规则生效的时间窗口。",
"description": "规则生效的时间窗口。省略或传空数组时，默认每天 00:00–23:59 生效。",
"default": [
{
"days": [
1,
2,
3,
4,
5,
6,
0
],
"stime": "00:00",
"etime": "23:59"
}
],
"items": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -38393,7 +38425,9 @@
"enum": [
"text",
"markdown"
]
],
"default": "text",
"description": "描述内容的格式。省略或为空时默认使用 `text`。"
},
"description": {
"type": "string"
Expand Down
2 changes: 1 addition & 1 deletion status_pages.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.