Skip to content

api: document detail_url on AlertInfo and AlertItem - #621

Merged
ysyneu merged 1 commit into
mainfrom
docs/openapi-alert-detail-url
Sep 29, 2026
Merged

ysyneu merged 1 commit into
mainfrom
docs/openapi-alert-detail-url

Conversation

@ysyneu

@ysyneu ysyneu commented Sep 29, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add detail_url to the AlertInfo and AlertItem schemas in api-reference/openapi.en.json and api-reference/openapi.zh.json
  • Field returns the console page URL for the alert ({console}/alert/detail/{alert_id}), empty when the deployment has no console base configured

Test plan

  • python3 scripts/lint_openapi.py — OK, no violations
  • mint broken-links — no broken links found

Both schemas return a console page URL for the alert
(`{console}/alert/detail/{alert_id}`), empty when the deployment has
no console base configured. Add the field to en and zh specs.
@ysyneu
ysyneu merged commit 0f8c119 into main Sep 29, 2026
2 checks passed
@ysyneu
ysyneu deleted the docs/openapi-alert-detail-url branch September 29, 2026 12:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant