From 4b9015a463bb6b5f5a8689befbb8dfd1d35ddee9 Mon Sep 17 00:00:00 2001 From: ysyneu Date: Tue, 29 Sep 2026 05:44:21 -0700 Subject: [PATCH] api: document detail_url on AlertInfo and AlertItem 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. --- api-reference/openapi.en.json | 8 ++++++++ api-reference/openapi.zh.json | 8 ++++++++ 2 files changed, 16 insertions(+) diff --git a/api-reference/openapi.en.json b/api-reference/openapi.en.json index ea38f102a..5c2bdd216 100644 --- a/api-reference/openapi.en.json +++ b/api-reference/openapi.en.json @@ -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", @@ -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", diff --git a/api-reference/openapi.zh.json b/api-reference/openapi.zh.json index 770ca7810..afedef7f7 100644 --- a/api-reference/openapi.zh.json +++ b/api-reference/openapi.zh.json @@ -1320,6 +1320,10 @@ "description": "告警描述。", "type": "string" }, + "detail_url": { + "description": "这条告警的控制台页面(`{控制台}/alert/detail/{alert_id}`)。部署没有配置控制台地址时为空。", + "type": "string" + }, "end_time": { "description": "告警恢复的 Unix 时间戳(秒),仍活跃时为 0。", "format": "int64", @@ -1541,6 +1545,10 @@ "description": "告警描述。", "type": "string" }, + "detail_url": { + "description": "这条告警的控制台页面(`{控制台}/alert/detail/{alert_id}`)。部署没有配置控制台地址时为空。", + "type": "string" + }, "end_time": { "description": "恢复时间,Unix 时间戳(秒)。活跃时为 0。", "format": "int64",