Skip to content

docs(api): daily audit 2026-10-08 — document the incident_list dashboard panel kind #1023

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

docs(api): daily audit 2026-10-08 — document the incident_list dashboard panel kind #1023

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
35 changes: 31 additions & 4 deletions api-reference/monitors.openapi.en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9351,7 +9351,7 @@
"$ref": "#/components/schemas/DashboardPanelQuery"
},
"maxItems": 26,
"description": "Queries in the panel. `time_series` accepts 1–26, `text` accepts none, every other kind accepts exactly one."
"description": "Queries in the panel. `time_series` accepts 1–26, `text` and `incident_list` accept none, every other kind accepts exactly one."
},
"viz_config": {
"$ref": "#/components/schemas/DashboardVizConfig"
Expand Down Expand Up @@ -9876,6 +9876,9 @@
},
{
"$ref": "#/components/schemas/DashboardTextViz"
},
{
"$ref": "#/components/schemas/DashboardIncidentListViz"
}
],
"discriminator": {
Expand All @@ -9887,7 +9890,8 @@
"bar": "#/components/schemas/DashboardBarViz",
"gauge": "#/components/schemas/DashboardGaugeViz",
"logs": "#/components/schemas/DashboardLogsViz",
"text": "#/components/schemas/DashboardTextViz"
"text": "#/components/schemas/DashboardTextViz",
"incident_list": "#/components/schemas/DashboardIncidentListViz"
}
}
},
Expand Down Expand Up @@ -10259,6 +10263,28 @@
"markdown"
]
},
"DashboardIncidentListViz": {
"type": "object",
"description": "Incident-list panel. The rows are filled by the client from the Flashduty incident API, so the panel runs no queries and needs no datasource.",
"properties": {
"kind": {
"type": "string",
"enum": [
"incident_list"
],
"description": "Visualization kind discriminator; always `incident_list`."
},
"options": {
"type": "object",
"additionalProperties": true,
"description": "Open options object for the chosen visualization kind; the only part of the definition that round-trips losslessly. Missing or null normalizes to `{}`."
}
},
"required": [
"kind",
"options"
]
},
"DashboardThreshold": {
"type": "object",
"description": "Colour threshold for a numeric value. At least one of `warning`/`critical` is required, and with both set the pair must be ordered according to `mode`.",
Expand Down Expand Up @@ -11082,9 +11108,10 @@
"bar",
"gauge",
"logs",
"text"
"text",
"incident_list"
],
"description": "Visualization kind: `time_series` = time series; `table` = table; `stat` = single value; `bar` = bar chart; `gauge` = gauge; `logs` = log stream; `text` = Markdown text."
"description": "Visualization kind: `time_series` = time series; `table` = table; `stat` = single value; `bar` = bar chart; `gauge` = gauge; `logs` = log stream; `text` = Markdown text; `incident_list` = incident list."
}
},
"required": [
Expand Down
35 changes: 31 additions & 4 deletions api-reference/monitors.openapi.zh.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9351,7 +9351,7 @@
"$ref": "#/components/schemas/DashboardPanelQuery"
},
"maxItems": 26,
"description": "面板内的查询。`time_series` 允许 1～26 条，`text` 不允许查询，其余类型必须恰好 1 条。"
"description": "面板内的查询。`time_series` 允许 1～26 条，`text`、`incident_list` 不允许查询，其余类型必须恰好 1 条。"
},
"viz_config": {
"$ref": "#/components/schemas/DashboardVizConfig"
Expand Down Expand Up @@ -9876,6 +9876,9 @@
},
{
"$ref": "#/components/schemas/DashboardTextViz"
},
{
"$ref": "#/components/schemas/DashboardIncidentListViz"
}
],
"discriminator": {
Expand All @@ -9887,7 +9890,8 @@
"bar": "#/components/schemas/DashboardBarViz",
"gauge": "#/components/schemas/DashboardGaugeViz",
"logs": "#/components/schemas/DashboardLogsViz",
"text": "#/components/schemas/DashboardTextViz"
"text": "#/components/schemas/DashboardTextViz",
"incident_list": "#/components/schemas/DashboardIncidentListViz"
}
}
},
Expand Down Expand Up @@ -10259,6 +10263,28 @@
"markdown"
]
},
"DashboardIncidentListViz": {
"type": "object",
"description": "故障列表面板。数据由前端从 Flashduty 故障接口获取，因此面板不运行查询、也不需要数据源。",
"properties": {
"kind": {
"type": "string",
"enum": [
"incident_list"
],
"description": "可视化类型判别字段，固定为 `incident_list`。"
},
"options": {
"type": "object",
"additionalProperties": true,
"description": "所选可视化类型的开放配置对象；也是定义中唯一无损 round-trip 的部分。缺失或 null 时规范化为 `{}`。"
}
},
"required": [
"kind",
"options"
]
},
"DashboardThreshold": {
"type": "object",
"description": "数值的颜色阈值。`warning`/`critical` 至少设置一个；两者都设置时需按 `mode` 满足大小关系。",
Expand Down Expand Up @@ -11082,9 +11108,10 @@
"bar",
"gauge",
"logs",
"text"
"text",
"incident_list"
],
"description": "可视化类型：`time_series` = 时序图；`table` = 表格；`stat` = 单值；`bar` = 柱状图；`gauge` = 仪表盘；`logs` = 日志流；`text` = Markdown 文本。"
"description": "可视化类型：`time_series` = 时序图；`table` = 表格；`stat` = 单值；`bar` = 柱状图；`gauge` = 仪表盘；`logs` = 日志流；`text` = Markdown 文本；`incident_list` = 故障列表。"
}
},
"required": [
Expand Down
2 changes: 1 addition & 1 deletion api-reference/on-call.openapi.en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24010,7 +24010,7 @@
"deleted_at": {
"type": "integer",
"format": "int64",
"description": "Soft-delete timestamp (ms). Zero if not deleted."
"description": "Soft-delete timestamp in milliseconds. Zero if not deleted."
},
"created_at": {
"type": "integer",
Expand Down
37 changes: 32 additions & 5 deletions api-reference/openapi.en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11387,7 +11387,7 @@
"type": "integer"
},
"deleted_at": {
"description": "Soft-delete timestamp (ms). Zero if not deleted.",
"description": "Soft-delete timestamp in milliseconds. Zero if not deleted.",
"format": "int64",
"type": "integer"
},
Expand Down Expand Up @@ -29665,7 +29665,7 @@
"$ref": "#/components/schemas/DashboardPanelQuery"
},
"maxItems": 26,
"description": "Queries in the panel. `time_series` accepts 1–26, `text` accepts none, every other kind accepts exactly one."
"description": "Queries in the panel. `time_series` accepts 1–26, `text` and `incident_list` accept none, every other kind accepts exactly one."
},
"viz_config": {
"$ref": "#/components/schemas/DashboardVizConfig"
Expand Down Expand Up @@ -30190,6 +30190,9 @@
},
{
"$ref": "#/components/schemas/DashboardTextViz"
},
{
"$ref": "#/components/schemas/DashboardIncidentListViz"
}
],
"discriminator": {
Expand All @@ -30201,7 +30204,8 @@
"bar": "#/components/schemas/DashboardBarViz",
"gauge": "#/components/schemas/DashboardGaugeViz",
"logs": "#/components/schemas/DashboardLogsViz",
"text": "#/components/schemas/DashboardTextViz"
"text": "#/components/schemas/DashboardTextViz",
"incident_list": "#/components/schemas/DashboardIncidentListViz"
}
}
},
Expand Down Expand Up @@ -30573,6 +30577,28 @@
"markdown"
]
},
"DashboardIncidentListViz": {
"type": "object",
"description": "Incident-list panel. The rows are filled by the client from the Flashduty incident API, so the panel runs no queries and needs no datasource.",
"properties": {
"kind": {
"type": "string",
"enum": [
"incident_list"
],
"description": "Visualization kind discriminator; always `incident_list`."
},
"options": {
"type": "object",
"additionalProperties": true,
"description": "Open options object for the chosen visualization kind; the only part of the definition that round-trips losslessly. Missing or null normalizes to `{}`."
}
},
"required": [
"kind",
"options"
]
},
"DashboardThreshold": {
"type": "object",
"description": "Colour threshold for a numeric value. At least one of `warning`/`critical` is required, and with both set the pair must be ordered according to `mode`.",
Expand Down Expand Up @@ -31396,9 +31422,10 @@
"bar",
"gauge",
"logs",
"text"
"text",
"incident_list"
],
"description": "Visualization kind: `time_series` = time series; `table` = table; `stat` = single value; `bar` = bar chart; `gauge` = gauge; `logs` = log stream; `text` = Markdown text."
"description": "Visualization kind: `time_series` = time series; `table` = table; `stat` = single value; `bar` = bar chart; `gauge` = gauge; `logs` = log stream; `text` = Markdown text; `incident_list` = incident list."
}
},
"required": [
Expand Down
35 changes: 31 additions & 4 deletions api-reference/openapi.zh.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29665,7 +29665,7 @@
"$ref": "#/components/schemas/DashboardPanelQuery"
},
"maxItems": 26,
"description": "面板内的查询。`time_series` 允许 1～26 条，`text` 不允许查询，其余类型必须恰好 1 条。"
"description": "面板内的查询。`time_series` 允许 1～26 条，`text`、`incident_list` 不允许查询，其余类型必须恰好 1 条。"
},
"viz_config": {
"$ref": "#/components/schemas/DashboardVizConfig"
Expand Down Expand Up @@ -30190,6 +30190,9 @@
},
{
"$ref": "#/components/schemas/DashboardTextViz"
},
{
"$ref": "#/components/schemas/DashboardIncidentListViz"
}
],
"discriminator": {
Expand All @@ -30201,7 +30204,8 @@
"bar": "#/components/schemas/DashboardBarViz",
"gauge": "#/components/schemas/DashboardGaugeViz",
"logs": "#/components/schemas/DashboardLogsViz",
"text": "#/components/schemas/DashboardTextViz"
"text": "#/components/schemas/DashboardTextViz",
"incident_list": "#/components/schemas/DashboardIncidentListViz"
}
}
},
Expand Down Expand Up @@ -30573,6 +30577,28 @@
"markdown"
]
},
"DashboardIncidentListViz": {
"type": "object",
"description": "故障列表面板。数据由前端从 Flashduty 故障接口获取，因此面板不运行查询、也不需要数据源。",
"properties": {
"kind": {
"type": "string",
"enum": [
"incident_list"
],
"description": "可视化类型判别字段，固定为 `incident_list`。"
},
"options": {
"type": "object",
"additionalProperties": true,
"description": "所选可视化类型的开放配置对象；也是定义中唯一无损 round-trip 的部分。缺失或 null 时规范化为 `{}`。"
}
},
"required": [
"kind",
"options"
]
},
"DashboardThreshold": {
"type": "object",
"description": "数值的颜色阈值。`warning`/`critical` 至少设置一个；两者都设置时需按 `mode` 满足大小关系。",
Expand Down Expand Up @@ -31396,9 +31422,10 @@
"bar",
"gauge",
"logs",
"text"
"text",
"incident_list"
],
"description": "可视化类型：`time_series` = 时序图；`table` = 表格；`stat` = 单值；`bar` = 柱状图；`gauge` = 仪表盘；`logs` = 日志流；`text` = Markdown 文本。"
"description": "可视化类型：`time_series` = 时序图；`table` = 表格；`stat` = 单值；`bar` = 柱状图；`gauge` = 仪表盘；`logs` = 日志流；`text` = Markdown 文本；`incident_list` = 故障列表。"
}
},
"required": [
Expand Down
Loading