Skip to content

api: document detail_url on AlertInfo and AlertItem #621

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
Sep 29, 2026
Merged

api: document detail_url on AlertInfo and AlertItem #621

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
8 changes: 8 additions & 0 deletions api-reference/openapi.en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1320,6 +1320,10 @@
"description": "Alert description.",
"type": "string"
},
"detail_url": {
"description": "Console URL of this alert (`{console}/alert/detail/{alert_id}`). Empty when the deployment has no console base configured.",
"type": "string"
},
"end_time": {
"description": "Unix timestamp (seconds) when the alert recovered. 0 if still active.",
"format": "int64",
Expand Down Expand Up @@ -1541,6 +1545,10 @@
"description": "Alert description.",
"type": "string"
},
"detail_url": {
"description": "Console URL of this alert (`{console}/alert/detail/{alert_id}`). Empty when the deployment has no console base configured.",
"type": "string"
},
"end_time": {
"description": "Resolution time, Unix epoch seconds. 0 if still active.",
"format": "int64",
Expand Down
8 changes: 8 additions & 0 deletions api-reference/openapi.zh.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1320,6 +1320,10 @@
"description": "告警描述。",
"type": "string"
},
"detail_url": {
"description": "这条告警的控制台页面（`{控制台}/alert/detail/{alert_id}`）。部署没有配置控制台地址时为空。",
"type": "string"
},
"end_time": {
"description": "告警恢复的 Unix 时间戳（秒），仍活跃时为 0。",
"format": "int64",
Expand Down Expand Up @@ -1541,6 +1545,10 @@
"description": "告警描述。",
"type": "string"
},
"detail_url": {
"description": "这条告警的控制台页面（`{控制台}/alert/detail/{alert_id}`）。部署没有配置控制台地址时为空。",
"type": "string"
},
"end_time": {
"description": "恢复时间，Unix 时间戳（秒）。活跃时为 0。",
"format": "int64",
Expand Down
Loading