Skip to content

docs(api): sync OpenAPI specs with current backend handlers #322

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 2 commits into from
Aug 28, 2026
Merged

docs(api): sync OpenAPI specs with current backend handlers #322

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7ff481b
docs(on-call): full doc-review audit — mobile app & external submissi…
ysyneu Aug 28, 2026
cb2d15c
docs(api): sync OpenAPI specs with current backend handlers
ysyneu Aug 28, 2026
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
795 changes: 416 additions & 379 deletions api-reference/monitors.openapi.en.json
View file
Open in desktop

Large diffs are not rendered by default.

861 changes: 449 additions & 412 deletions api-reference/monitors.openapi.zh.json
View file
Open in desktop

Large diffs are not rendered by default.

2,277 changes: 1,520 additions & 757 deletions api-reference/on-call.openapi.en.json
View file
Open in desktop

Large diffs are not rendered by default.

2,376 changes: 1,574 additions & 802 deletions api-reference/on-call.openapi.zh.json
View file
Open in desktop

Large diffs are not rendered by default.

4,362 changes: 2,716 additions & 1,646 deletions api-reference/openapi.en.json
View file
Open in desktop

Large diffs are not rendered by default.

4,557 changes: 2,818 additions & 1,739 deletions api-reference/openapi.zh.json
View file
Open in desktop

Large diffs are not rendered by default.

444 changes: 331 additions & 113 deletions api-reference/platform.openapi.en.json
View file
Open in desktop

Large diffs are not rendered by default.

478 changes: 348 additions & 130 deletions api-reference/platform.openapi.zh.json
View file
Open in desktop

Large diffs are not rendered by default.

343 changes: 217 additions & 126 deletions api-reference/rum.openapi.en.json
View file
Open in desktop

Large diffs are not rendered by default.

383 changes: 237 additions & 146 deletions api-reference/rum.openapi.zh.json
View file
Open in desktop

Large diffs are not rendered by default.

396 changes: 166 additions & 230 deletions api-reference/safari.openapi.en.json
View file
Open in desktop

Large diffs are not rendered by default.

394 changes: 165 additions & 229 deletions api-reference/safari.openapi.zh.json
View file
Open in desktop

Large diffs are not rendered by default.

62 changes: 40 additions & 22 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1386,6 +1386,14 @@
{
"source": "/en/flashduty/Wecom-alert-integration-guide",
"destination": "/en/on-call/integration/alert-integration/alert-sources/wecom-alert"
},
{
"source": "/zh/on-call/integration/alert-integration/alert-sources/overview",
"destination": "/zh/on-call/integration/alert-integration/alert-sources/standard-alert"
},
{
"source": "/en/on-call/integration/alert-integration/alert-sources/overview",
"destination": "/en/on-call/integration/alert-integration/alert-sources/standard-alert"
}
],
"navigation": {
Expand Down Expand Up @@ -1538,6 +1546,7 @@
"icon": "rocket",
"pages": [
"zh/on-call/quickstart/quickstart",
"zh/on-call/quickstart/mobile-app",
"zh/on-call/quickstart/faq",
"zh/on-call/quickstart/comparison"
]
Expand All @@ -1564,7 +1573,8 @@
"zh/on-call/incident/alert-management",
"zh/on-call/incident/custom-actions",
"zh/on-call/incident/past-incidents",
"zh/on-call/incident/outlier-incidents"
"zh/on-call/incident/outlier-incidents",
"zh/on-call/incident/external-submission"
]
},
{
Expand Down Expand Up @@ -1640,6 +1650,7 @@
"expanded": false,
"pages": [
"zh/on-call/integration/alert-integration/alert-sources/standard-alert",
"zh/on-call/integration/alert-integration/alert-sources/email",
"zh/on-call/integration/alert-integration/alert-sources/http-pull",
"zh/on-call/integration/alert-integration/alert-sources/db-pull",
"zh/on-call/integration/alert-integration/alert-sources/prometheus",
Expand All @@ -1660,9 +1671,13 @@
"zh/on-call/integration/alert-integration/alert-sources/aliyun-prometheus",
"zh/on-call/integration/alert-integration/alert-sources/aws-cloudwatch",
"zh/on-call/integration/alert-integration/alert-sources/aws-eventbridge",
"zh/on-call/integration/alert-integration/alert-sources/azure-monitor",
"zh/on-call/integration/alert-integration/alert-sources/google-cloud-monitoring",
"zh/on-call/integration/alert-integration/alert-sources/tencent-cls",
"zh/on-call/integration/alert-integration/alert-sources/tencent-cm",
"zh/on-call/integration/alert-integration/alert-sources/tencent-eventbridge",
"zh/on-call/integration/alert-integration/alert-sources/baidu-bcm",
"zh/on-call/integration/alert-integration/alert-sources/ctyun",
"zh/on-call/integration/alert-integration/alert-sources/huawei-ces",
"zh/on-call/integration/alert-integration/alert-sources/huawei-lts",
"zh/on-call/integration/alert-integration/alert-sources/huawei-apm",
Expand All @@ -1685,11 +1700,18 @@
"zh/on-call/integration/alert-integration/alert-sources/cloudflare",
"zh/on-call/integration/alert-integration/alert-sources/meraki",
"zh/on-call/integration/alert-integration/alert-sources/monit",
"zh/on-call/integration/alert-integration/alert-sources/rum-alert",
"zh/on-call/integration/alert-integration/alert-sources/harbor",
"zh/on-call/integration/alert-integration/alert-sources/ucloud-cloudwatch",
"zh/on-call/integration/alert-integration/alert-sources/jdcloud",
"zh/on-call/integration/alert-integration/alert-sources/volcengine-rtc",
"zh/on-call/integration/alert-integration/alert-sources/nagios"
"zh/on-call/integration/alert-integration/alert-sources/volcengine-dial",
"zh/on-call/integration/alert-integration/alert-sources/nagios",
"zh/on-call/integration/alert-integration/alert-sources/emqx",
"zh/on-call/integration/alert-integration/alert-sources/rizhiyi",
"zh/on-call/integration/alert-integration/alert-sources/dingtalk-alert",
"zh/on-call/integration/alert-integration/alert-sources/lark-alert",
"zh/on-call/integration/alert-integration/alert-sources/wecom-alert"
]
},
{
Expand Down Expand Up @@ -2444,7 +2466,6 @@
"POST /monit/rule/import",
"POST /monit/rule/export",
"POST /monit/rule/move",
"POST /monit/rule/status",
"POST /monit/rule/audits",
"POST /monit/rule/audit/detail",
"POST /monit/rule/dstypes",
Expand Down Expand Up @@ -2483,20 +2504,12 @@
"icon": "stethoscope",
"pages": [
"POST /monit/query/data",
"POST /monit/query/rows",
"POST /monit/query/diagnose",
"POST /monit/tools/catalog",
"POST /monit/tools/invoke",
"POST /monit/targets"
]
},
{
"group": "通用工具",
"icon": "wrench",
"pages": [
"POST /monit/preview/sync"
]
},
{
"group": "服务拓扑",
"icon": "diagram-project",
Expand Down Expand Up @@ -2908,6 +2921,7 @@
"icon": "rocket",
"pages": [
"en/on-call/quickstart/quickstart",
"en/on-call/quickstart/mobile-app",
"en/on-call/quickstart/faq",
"en/on-call/quickstart/comparison"
]
Expand All @@ -2934,7 +2948,8 @@
"en/on-call/incident/alert-management",
"en/on-call/incident/custom-actions",
"en/on-call/incident/past-incidents",
"en/on-call/incident/outlier-incidents"
"en/on-call/incident/outlier-incidents",
"en/on-call/incident/external-submission"
]
},
{
Expand Down Expand Up @@ -3010,6 +3025,7 @@
"expanded": false,
"pages": [
"en/on-call/integration/alert-integration/alert-sources/standard-alert",
"en/on-call/integration/alert-integration/alert-sources/email",
"en/on-call/integration/alert-integration/alert-sources/http-pull",
"en/on-call/integration/alert-integration/alert-sources/db-pull",
"en/on-call/integration/alert-integration/alert-sources/prometheus",
Expand All @@ -3030,9 +3046,13 @@
"en/on-call/integration/alert-integration/alert-sources/aliyun-prometheus",
"en/on-call/integration/alert-integration/alert-sources/aws-cloudwatch",
"en/on-call/integration/alert-integration/alert-sources/aws-eventbridge",
"en/on-call/integration/alert-integration/alert-sources/azure-monitor",
"en/on-call/integration/alert-integration/alert-sources/google-cloud-monitoring",
"en/on-call/integration/alert-integration/alert-sources/tencent-cls",
"en/on-call/integration/alert-integration/alert-sources/tencent-cm",
"en/on-call/integration/alert-integration/alert-sources/tencent-eventbridge",
"en/on-call/integration/alert-integration/alert-sources/baidu-bcm",
"en/on-call/integration/alert-integration/alert-sources/ctyun",
"en/on-call/integration/alert-integration/alert-sources/huawei-ces",
"en/on-call/integration/alert-integration/alert-sources/huawei-lts",
"en/on-call/integration/alert-integration/alert-sources/huawei-apm",
Expand All @@ -3055,11 +3075,18 @@
"en/on-call/integration/alert-integration/alert-sources/cloudflare",
"en/on-call/integration/alert-integration/alert-sources/meraki",
"en/on-call/integration/alert-integration/alert-sources/monit",
"en/on-call/integration/alert-integration/alert-sources/rum-alert",
"en/on-call/integration/alert-integration/alert-sources/harbor",
"en/on-call/integration/alert-integration/alert-sources/ucloud-cloudwatch",
"en/on-call/integration/alert-integration/alert-sources/jdcloud",
"en/on-call/integration/alert-integration/alert-sources/volcengine-rtc",
"en/on-call/integration/alert-integration/alert-sources/nagios"
"en/on-call/integration/alert-integration/alert-sources/volcengine-dial",
"en/on-call/integration/alert-integration/alert-sources/nagios",
"en/on-call/integration/alert-integration/alert-sources/emqx",
"en/on-call/integration/alert-integration/alert-sources/rizhiyi",
"en/on-call/integration/alert-integration/alert-sources/dingtalk-alert",
"en/on-call/integration/alert-integration/alert-sources/lark-alert",
"en/on-call/integration/alert-integration/alert-sources/wecom-alert"
]
},
{
Expand Down Expand Up @@ -3814,7 +3841,6 @@
"POST /monit/rule/import",
"POST /monit/rule/export",
"POST /monit/rule/move",
"POST /monit/rule/status",
"POST /monit/rule/audits",
"POST /monit/rule/audit/detail",
"POST /monit/rule/dstypes",
Expand Down Expand Up @@ -3853,20 +3879,12 @@
"icon": "stethoscope",
"pages": [
"POST /monit/query/data",
"POST /monit/query/rows",
"POST /monit/query/diagnose",
"POST /monit/tools/catalog",
"POST /monit/tools/invoke",
"POST /monit/targets"
]
},
{
"group": "Monitor utilities",
"icon": "wrench",
"pages": [
"POST /monit/preview/sync"
]
},
{
"group": "Service map",
"icon": "diagram-project",
Expand Down
12 changes: 12 additions & 0 deletions en/changelog/changelog.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,18 @@ See [AI SRE](/en/ai-sre) and the [quickstart](/en/ai-sre/quickstart).

</Update>

<Update label="2026-07-22" description="💬 @mention notifications in incident comments">

### @mention notifications in incident comments

Mention a member with `@` in incident comments or postmortem reports, and the mentioned person is notified in real time — key collaboration signals no longer get buried:

- Type `@` in the incident detail comment area or in a postmortem report to select and mention a member. The notification carries the comment content, an incident summary, and a detail link that jumps straight to the incident
- Notification channels follow the mentioned person's preferences: SMS, email, and all IM apps (DingTalk, Feishu/Lark, WeCom, Slack, Microsoft Teams) are supported, with email as the default
- Adjust how you receive these under **Personal Center → Notification Preferences → Collaboration & follow-up → Collaboration Mention**; the same comment never triggers duplicate notifications

</Update>

<Update label="2026-07-08" description="🤖 AI SRE automation, IM, and Runner enhancements">

### AI SRE autonomous investigation Agent
Expand Down
5 changes: 2 additions & 3 deletions en/developer/cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -474,12 +474,11 @@ FDUTY

### monit-query — Monitoring datasource queries

Probe monitoring back-end datasources directly, bypassing the alert-rule layer. The `data` subcommand supports 9 datasource types (Prometheus, VictoriaLogs, Loki, MySQL, SLS, Elasticsearch, PostgreSQL, Oracle, ClickHouse); `diagnose` supports `prometheus` (metric trends), `victorialogs`, `loki` (log patterns); the deprecated `rows` supports `prometheus`, `victorialogs`, `loki`, `mysql`.
Probe monitoring back-end datasources directly, bypassing the alert-rule layer. The `data` subcommand supports 9 datasource types (Prometheus, VictoriaLogs, Loki, MySQL, SLS, Elasticsearch, PostgreSQL, Oracle, ClickHouse); `diagnose` supports `prometheus` (metric trends), `victorialogs`, and `loki` (log patterns).

```bash
flashduty monit-query diagnose [flags] # Pre-clustered RCA findings (log patterns or metric trends)
flashduty monit-query data [flags] # Structured datasource query (recommended)
flashduty monit-query rows [flags] # Raw datasource passthrough query (deprecated — use data)
flashduty monit-query data [flags] # Structured datasource query
```

Common flags for `diagnose`:
Expand Down
3 changes: 1 addition & 2 deletions en/developer/go-sdk.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,6 @@ Endpoints are grouped by service and hang off the client: the call convention is
| `client.NotificationTemplates` | Notification templates |
| `client.Changes` | Changes |
| `client.Diagnostics` | Diagnostics |
| `client.MonitorUtilities` | Monitor datasource preview |
| `client.ServiceMap` | Service map (ServiceMap) |
| `client.Analytics` | Analytics |
| `client.A2aAgents` | A2A Agents |
Expand All @@ -182,7 +181,7 @@ Endpoints are grouped by service and hang off the client: the call convention is

`client.Knowledge` covers the 9 operations under `/safari/knowledge/*`: on the pack side `PackReadGet` (get the account pack), `PackReadList` (list packs), `PackWriteEnsure` (ensure a pack exists), `PackWriteUpdate` (change a pack's scope), and `PackWriteDelete` (delete a pack); on the file side `FileReadGet`, `FileReadList`, `FileWritePut` (upload/overwrite), and `FileWriteDelete`. Exported types include `KnowledgePackItem`, `KnowledgeFileItem`, `KnowledgeWarning`, and the various `Knowledge*Request` / `Knowledge*Response` structs.

`client.Diagnostics` (diagnostics) provides datasource query methods: `QueryData` runs a synchronous query via `POST /monit/query/data` and returns a stable `query_result.v1` structured result (`format` is always `query_result.v1`; `result.kind` is one of `frames` / `records` / `samples`). This API requires monit-edge v0.65.0 or later. `QueryRows` (`POST /monit/query/rows`) is deprecated and returns the legacy flattened rows shape — migrate to `QueryData`. `QueryDiagnose` (`POST /monit/query/diagnose`) runs pre-clustered RCA analysis (log patterns or metric trends) and can take up to 35 seconds.
`client.Diagnostics` (diagnostics) provides datasource query methods: `QueryData` runs a synchronous query via `POST /monit/query/data` and returns a stable `query_result.v1` structured result (`format` is always `query_result.v1`; `result.kind` is one of `frames` / `records` / `samples`). This API requires monit-edge v0.65.0 or later. `QueryDiagnose` (`POST /monit/query/diagnose`) runs pre-clustered RCA analysis (log patterns or metric trends) and can take up to 35 seconds.

<Note>
All identifiers, service field names, and method names match the generated code. For exactly which methods each service has and their request and response types, rely on `services_gen.go` and the per-service files, plus the [Open API reference](/en/openapi/introduction).
Expand Down
18 changes: 14 additions & 4 deletions en/on-call/analytics/insights.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ When customizing filter conditions, the system remembers your selections. Even a
| Team | Select team names to query, supports multiple selection. Dashboard data updates based on selected teams |
| Channel | Select channel names to query, supports multiple selection. Dashboard data updates based on selected channels |
| Severity | Select severity levels to query, supports multiple selection. Dashboard data updates based on selected severity levels |
| Time Range | Select time range to query. Supports this week, last two weeks, this month, last month, and custom time ranges, but only up to the last **1 year** of data |
| Time Range | Select time range to query. Supports this week, last two weeks, this month, last month, and custom time ranges, querying up to the last **2 years (720 days)** of data (the exact limit depends on your plan) |
| Data Interval | Supports day, week, and month dimensions. Defaults to hourly queries, but when time range exceeds 31 days, daily preview is not available |
| Sorting | Team, channel, and individual dimension dashboards support ascending and descending order. Defaults to showing TOP 10 data; expand to show more |

Expand Down Expand Up @@ -107,9 +107,19 @@ All dimensions support downloading dashboards in PDF format for further data ana
</Tab>

<Tab title="Data Export">
Export incident list, team, channel, and individual dimension data in CSV format. Before exporting, choose the fields you need in the popover. Incident list exports use a **fixed set** of 28 fields: incident ID, title, severity, progress, channel ID, channel, team ID, team, triggered at, time to acknowledge, time to close, closed by, response engagement, notification count, interruption count, acknowledgement count, assignment count, reassignment count, escalation count, manual escalation count, timeout escalation count, assigned to, responders, description, labels, custom fields, creator ID, and creator name. Enable **Extract text content from HTML** to write incident descriptions as plain text in the CSV, which makes them easier to read in spreadsheet tools.
Export incident list, team, channel, and individual dimension data in CSV format, with a maximum of **10,000** records per export. Before exporting, choose the fields you need in the popover. The incident list export offers **42 selectable fields** (all selected by default), grouped by purpose:

Incident list export fields do not change with the extended fields shown on the page: alert count, active alert count, alert events, owner, closer, snoozed until, ever muted, and outlier incident are display-only extended fields and are not included in CSV exports.
| Group | Fields |
| :--- | :--- |
| Basics | Incident ID, Incident title, Severity, Progress, Description, Labels, Custom fields |
| Ownership | Channel ID, Channel, Team ID, Team |
| Time & Efficiency | Triggered at, Time to ack, Time to close, Close by, Response effort, Hours |
| Notifications & Assignment | Notifications, Interruptions, Acknowledgements, Assignments, Reassignments, Escalations, Manual escalations, Auto escalations, Assign method, Responders, Raw assigned to, Raw responders, Escalation rules |
| Associated Alerts | Alerts, Active alerts, Alert events |
| People | Owner ID, Owner, Creator ID, Creator, Closer ID, Closer |
| Others | Snoozed until, Ever muted, Rare incident |

Enable **Extract text content from HTML** (on by default) to write incident descriptions as plain text in the CSV, which makes them easier to read in spreadsheet tools.

<Frame>
<img src="https://download.flashcat.cloud/flashduty/doc/zh/fd/insight-5.png" alt="Data Export Diagram" />
Expand Down Expand Up @@ -140,7 +150,7 @@ Usage statistics help you understand overall platform usage for capacity plannin

<AccordionGroup>
<Accordion title="How can I query older data?">
Currently, insights only supports querying the last 1 year (depending on your plan's data retention period) of data. For older data, use the [API Query](/en/api-reference/on-call/analytics/insight-incident-list).
Currently, insights supports querying up to the last **2 years (720 days)** of data (the exact limit depends on your plan). For older data, use the [API Query](/en/api-reference/on-call/analytics/insight-incident-list).
</Accordion>

<Accordion title="Why can't I view data at daily granularity when the time range exceeds 31 days?">
Expand Down
Loading
Loading