Skip to content

Commit b86c63d

Browse files
authored
Merge pull request #508 from flashcatcloud/doc-review/2026-09-28-080453
docs: doc-review 2026-09-28 (diff) — CLI incident projection fields and alert webhook detail_url
2 parents 2d3df69 + b3a9098 commit b86c63d

4 files changed

Lines changed: 6 additions & 4 deletions

File tree

‎en/developer/cli.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -842,8 +842,8 @@ The following commands support `--fields` with `json` or `toon` output. Supply c
842842

843843
| Command | Structured output when `--fields` is omitted | Limit |
844844
| --- | --- | --- |
845-
| `flashduty incident list` | `incident_id`, `title`, `incident_severity`, `progress`, `start_time`, `channel_id` | 16 KiB |
846-
| `flashduty incident similar <id>` | `incident_id`, `title`, `incident_severity`, `progress`, `start_time`, `close_time`, `ack_time`, `alert_cnt`, `root_cause`, `score` | 16 KiB |
845+
| `flashduty incident list` | `incident_id`, `num`, `title`, `incident_severity`, `progress`, `start_time`, `channel_id`, `detail_url` | 16 KiB |
846+
| `flashduty incident similar <id>` | `incident_id`, `num`, `title`, `incident_severity`, `progress`, `start_time`, `close_time`, `ack_time`, `alert_cnt`, `root_cause`, `score`, `detail_url` | 16 KiB |
847847
| `flashduty incident detail <id>` | Returns full detail when `--fields` is omitted; otherwise returns only the selected fields | 8 KiB for projections only |
848848
| `flashduty alert-event list` | `event_id`, `alert_id`, `event_severity`, `event_status`, `event_time`, `title` | 16 KiB |
849849
| `flashduty channel escalate-rule-list <channel-id>` | `rule_id`, `rule_name`, `status`, `priority`, `filters` | 16 KiB |

‎en/on-call/integration/webhooks/alert-webhook.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,7 @@ alt | string | Yes | Caption; may be an empty string
103103
| images | [][Image](#Image) | Yes | Alert image list; null when there are no images |
104104
| labels | map[string]string | No | Label KV, both Key and Value are strings |
105105
| event_cnt | int64 | No | Associated event count |
106+
| detail_url | string | No | Console page for this alert, in the form `{console}/alert/detail/{alert_id}`; the field is omitted when the deployment has no console base configured |
106107
| incident | [Incident](#Incident) | No | Associated incident |
107108

108109
<span id="Incident"></span>

‎zh/developer/cli.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -842,8 +842,8 @@ TOON 不能直接用 `jq` 解析;需要管道给 `jq` 时请改用 `--json`。
842842

843843
| 命令 | 未指定 `--fields` 时的结构化输出 | 上限 |
844844
| --- | --- | --- |
845-
| `flashduty incident list` | `incident_id`、`title`、`incident_severity`、`progress`、`start_time`、`channel_id` | 16 KiB |
846-
| `flashduty incident similar <id>` | `incident_id`、`title`、`incident_severity`、`progress`、`start_time`、`close_time`、`ack_time`、`alert_cnt`、`root_cause`、`score` | 16 KiB |
845+
| `flashduty incident list` | `incident_id`、`num`、`title`、`incident_severity`、`progress`、`start_time`、`channel_id`、`detail_url` | 16 KiB |
846+
| `flashduty incident similar <id>` | `incident_id`、`num`、`title`、`incident_severity`、`progress`、`start_time`、`close_time`、`ack_time`、`alert_cnt`、`root_cause`、`score`、`detail_url` | 16 KiB |
847847
| `flashduty incident detail <id>` | 不指定 `--fields` 时返回完整详情;指定后只返回所选字段 | 仅投影输出为 8 KiB |
848848
| `flashduty alert-event list` | `event_id`、`alert_id`、`event_severity`、`event_status`、`event_time`、`title` | 16 KiB |
849849
| `flashduty channel escalate-rule-list <channel-id>` | `rule_id`、`rule_name`、`status`、`priority`、`filters` | 16 KiB |

‎zh/on-call/integration/webhooks/alert-webhook.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,7 @@ alt | string | 是 | 图片说明,可能为空字符串
103103
| images | [][Image](#Image) | 是 | 告警图片列表,无图片时为 null|
104104
| labels | map[string]string | 否 | 标签 KV,Key 和 Value 均为字符串|
105105
| event_cnt | int64 | 否 | 关联事件个数|
106+
| detail_url | string | 否 | 该告警在控制台的详情页地址,形如 `{控制台}/alert/detail/{alert_id}`;部署未配置控制台地址时该字段不返回 |
106107
| incident | [Incident](#Incident) | 否 | 所属故障|
107108

108109
<span id="Incident"></span>

0 commit comments

Comments
 (0)