return ID in the api group info

Signed-off-by: Yijie Qin <[email protected]>
prometheus · Jul 6, 2023 · e16034e · e16034e
1 parent 8640e7e
commit e16034e
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 6 deletions.
diff --git a/api/v2/api.go b/api/v2/api.go
@@ -493,6 +493,7 @@ func (api *API) getAlertGroupInfoListHandler(params alertgroupinfolist_ops.GetAl
 			ag := &open_api_models.AlertGroupInfo{
 				Receiver: &open_api_models.Receiver{Name: &alertGroup.Receiver},
 				Labels:   ModelLabelSetToAPILabelSet(alertGroup.Labels),
+				ID:       &alertGroup.ID,
 			}
 
 			previousAgID = &alertGroup.ID

diff --git a/api/v2/api_test.go b/api/v2/api_test.go
@@ -198,28 +198,28 @@ func TestGetAlertGroupInfosHandler(t *testing.T) {
 		{
 			convertIntToPointerInt64(int64(1)),
 			nil,
-			`{"alertGroupInfoList":[{"labels":{"alertname":"TestingAlert","service":"api"},"receiver":{"name":"testing"}}],"nextToken":"478b4114226224a35910d449fdba8186ebfb441f"}`,
+			`{"alertGroupInfoList":[{"id":"478b4114226224a35910d449fdba8186ebfb441f","labels":{"alertname":"TestingAlert","service":"api"},"receiver":{"name":"testing"}}],"nextToken":"478b4114226224a35910d449fdba8186ebfb441f"}`,
 			200,
 		},
 		// One item to return, has next token.
 		{
 			convertIntToPointerInt64(int64(1)),
 			convertStringToPointer("478b4114226224a35910d449fdba8186ebfb441f"),
-			`{"alertGroupInfoList":[{"labels":{"alertname":"HighErrorRate","cluster":"bb","service":"api"},"receiver":{"name":"prod"}}],"nextToken":"7f4084a078a3fe29d6de82fad15af8f1411e803f"}`,
+			`{"alertGroupInfoList":[{"id":"7f4084a078a3fe29d6de82fad15af8f1411e803f","labels":{"alertname":"HighErrorRate","cluster":"bb","service":"api"},"receiver":{"name":"prod"}}],"nextToken":"7f4084a078a3fe29d6de82fad15af8f1411e803f"}`,
 			200,
 		},
 		// Five item to return, has next token.
 		{
 			convertIntToPointerInt64(int64(5)),
 			convertStringToPointer("7f4084a078a3fe29d6de82fad15af8f1411e803f"),
-			`{"alertGroupInfoList":[{"labels":{"alertname":"OtherAlert"},"receiver":{"name":"prod"}},{"labels":{"alertname":"HighErrorRate","cluster":"aa","service":"api"},"receiver":{"name":"prod"}}]}`,
+			`{"alertGroupInfoList":[{"id":"d525244929240cbdb75a497913c1890ab8de1962","labels":{"alertname":"OtherAlert"},"receiver":{"name":"prod"}},{"id":"d73984d43949112ae1ea59dcc5af4af7b630a5b1","labels":{"alertname":"HighErrorRate","cluster":"aa","service":"api"},"receiver":{"name":"prod"}}]}`,
 			200,
 		},
 		// Return all results.
 		{
 			nil,
 			nil,
-			`{"alertGroupInfoList":[{"labels":{"alertname":"TestingAlert","service":"api"},"receiver":{"name":"testing"}},{"labels":{"alertname":"HighErrorRate","cluster":"bb","service":"api"},"receiver":{"name":"prod"}},{"labels":{"alertname":"OtherAlert"},"receiver":{"name":"prod"}},{"labels":{"alertname":"HighErrorRate","cluster":"aa","service":"api"},"receiver":{"name":"prod"}}]}`,
+			`{"alertGroupInfoList":[{"id":"478b4114226224a35910d449fdba8186ebfb441f","labels":{"alertname":"TestingAlert","service":"api"},"receiver":{"name":"testing"}},{"id":"7f4084a078a3fe29d6de82fad15af8f1411e803f","labels":{"alertname":"HighErrorRate","cluster":"bb","service":"api"},"receiver":{"name":"prod"}},{"id":"d525244929240cbdb75a497913c1890ab8de1962","labels":{"alertname":"OtherAlert"},"receiver":{"name":"prod"}},{"id":"d73984d43949112ae1ea59dcc5af4af7b630a5b1","labels":{"alertname":"HighErrorRate","cluster":"aa","service":"api"},"receiver":{"name":"prod"}}]}`,
 			200,
 		},
 	} {

diff --git a/api/v2/models/alert_group_info.go b/api/v2/models/alert_group_info.go
diff --git a/api/v2/openapi.yaml b/api/v2/openapi.yaml
@@ -532,9 +532,12 @@ definitions:
         $ref: '#/definitions/labelSet'
       receiver:
         $ref: '#/definitions/receiver'
+      id:
+        type: string
     required:
       - labels
       - receiver
+      - id
   alertStatus:
     type: object
     properties:

diff --git a/api/v2/restapi/embedded_spec.go b/api/v2/restapi/embedded_spec.go