Skip to content

Commit 973937e

Browse files
chore: update alerting swagger spec
1 parent ae9460b commit 973937e

File tree

3 files changed

+59
-40
lines changed

3 files changed

+59
-40
lines changed

pkg/services/ngalert/api/tooling/api.json

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,9 @@
165165
},
166166
"AlertRuleEditorSettings": {
167167
"properties": {
168+
"simplified_notifications_section": {
169+
"type": "boolean"
170+
},
168171
"simplified_query_and_expressions_section": {
169172
"type": "boolean"
170173
}
@@ -755,7 +758,7 @@
755758
"type": "string"
756759
},
757760
"ErrorSource": {
758-
"$ref": "#/definitions/ErrorSource"
761+
"$ref": "#/definitions/Source"
759762
},
760763
"Frames": {
761764
"$ref": "#/definitions/Frames"
@@ -965,10 +968,6 @@
965968
},
966969
"type": "object"
967970
},
968-
"ErrorSource": {
969-
"description": "ErrorSource type defines the source of the error",
970-
"type": "string"
971-
},
972971
"ErrorType": {
973972
"title": "ErrorType models the different API error types.",
974973
"type": "string"
@@ -3606,6 +3605,9 @@
36063605
},
36073606
"RuleDiscovery": {
36083607
"properties": {
3608+
"groupNextToken": {
3609+
"type": "string"
3610+
},
36093611
"groups": {
36103612
"items": {
36113613
"$ref": "#/definitions/RuleGroup"
@@ -3975,6 +3977,10 @@
39753977
"SmtpNotEnabled": {
39763978
"$ref": "#/definitions/ResponseDetails"
39773979
},
3980+
"Source": {
3981+
"title": "Source type defines the status source.",
3982+
"type": "string"
3983+
},
39783984
"Span": {
39793985
"properties": {
39803986
"Length": {
@@ -4642,6 +4648,7 @@
46424648
"type": "object"
46434649
},
46444650
"alertGroups": {
4651+
"description": "AlertGroups alert groups",
46454652
"items": {
46464653
"$ref": "#/definitions/alertGroup",
46474654
"type": "object"
@@ -4803,6 +4810,7 @@
48034810
"type": "object"
48044811
},
48054812
"gettableAlerts": {
4813+
"description": "GettableAlerts gettable alerts",
48064814
"items": {
48074815
"$ref": "#/definitions/gettableAlert",
48084816
"type": "object"
@@ -4927,6 +4935,7 @@
49274935
"type": "object"
49284936
},
49294937
"gettableSilences": {
4938+
"description": "GettableSilences gettable silences",
49304939
"items": {
49314940
"$ref": "#/definitions/gettableSilence",
49324941
"type": "object"
@@ -6240,7 +6249,7 @@
62406249
}
62416250
}
62426251
},
6243-
"summary": "Get all notification templates.",
6252+
"summary": "Get all notification template groups.",
62446253
"tags": [
62456254
"provisioning"
62466255
]
@@ -6251,7 +6260,7 @@
62516260
"operationId": "RouteDeleteTemplate",
62526261
"parameters": [
62536262
{
6254-
"description": "Template name",
6263+
"description": "Template group name",
62556264
"in": "path",
62566265
"name": "name",
62576266
"required": true,
@@ -6275,7 +6284,7 @@
62756284
}
62766285
}
62776286
},
6278-
"summary": "Delete a template.",
6287+
"summary": "Delete a notification template group.",
62796288
"tags": [
62806289
"provisioning"
62816290
]
@@ -6284,7 +6293,7 @@
62846293
"operationId": "RouteGetTemplate",
62856294
"parameters": [
62866295
{
6287-
"description": "Template Name",
6296+
"description": "Template group name",
62886297
"in": "path",
62896298
"name": "name",
62906299
"required": true,
@@ -6305,7 +6314,7 @@
63056314
}
63066315
}
63076316
},
6308-
"summary": "Get a notification template.",
6317+
"summary": "Get a notification template group.",
63096318
"tags": [
63106319
"provisioning"
63116320
]
@@ -6317,7 +6326,7 @@
63176326
"operationId": "RoutePutTemplate",
63186327
"parameters": [
63196328
{
6320-
"description": "Template Name",
6329+
"description": "Template group name",
63216330
"in": "path",
63226331
"name": "name",
63236332
"required": true,
@@ -6356,7 +6365,7 @@
63566365
}
63576366
}
63586367
},
6359-
"summary": "Updates an existing notification template.",
6368+
"summary": "Updates an existing notification template group.",
63606369
"tags": [
63616370
"provisioning"
63626371
]

pkg/services/ngalert/api/tooling/post.json

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,9 @@
165165
},
166166
"AlertRuleEditorSettings": {
167167
"properties": {
168+
"simplified_notifications_section": {
169+
"type": "boolean"
170+
},
168171
"simplified_query_and_expressions_section": {
169172
"type": "boolean"
170173
}
@@ -755,7 +758,7 @@
755758
"type": "string"
756759
},
757760
"ErrorSource": {
758-
"$ref": "#/definitions/ErrorSource"
761+
"$ref": "#/definitions/Source"
759762
},
760763
"Frames": {
761764
"$ref": "#/definitions/Frames"
@@ -965,10 +968,6 @@
965968
},
966969
"type": "object"
967970
},
968-
"ErrorSource": {
969-
"description": "ErrorSource type defines the source of the error",
970-
"type": "string"
971-
},
972971
"ErrorType": {
973972
"title": "ErrorType models the different API error types.",
974973
"type": "string"
@@ -3606,6 +3605,9 @@
36063605
},
36073606
"RuleDiscovery": {
36083607
"properties": {
3608+
"groupNextToken": {
3609+
"type": "string"
3610+
},
36093611
"groups": {
36103612
"items": {
36113613
"$ref": "#/definitions/RuleGroup"
@@ -3975,6 +3977,10 @@
39753977
"SmtpNotEnabled": {
39763978
"$ref": "#/definitions/ResponseDetails"
39773979
},
3980+
"Source": {
3981+
"title": "Source type defines the status source.",
3982+
"type": "string"
3983+
},
39783984
"Span": {
39793985
"properties": {
39803986
"Length": {
@@ -4641,6 +4647,7 @@
46414647
"type": "object"
46424648
},
46434649
"alertGroups": {
4650+
"description": "AlertGroups alert groups",
46444651
"items": {
46454652
"$ref": "#/definitions/alertGroup",
46464653
"type": "object"
@@ -4802,7 +4809,6 @@
48024809
"type": "object"
48034810
},
48044811
"gettableAlerts": {
4805-
"description": "GettableAlerts gettable alerts",
48064812
"items": {
48074813
"$ref": "#/definitions/gettableAlert",
48084814
"type": "object"
@@ -4927,7 +4933,6 @@
49274933
"type": "object"
49284934
},
49294935
"gettableSilences": {
4930-
"description": "GettableSilences gettable silences",
49314936
"items": {
49324937
"$ref": "#/definitions/gettableSilence",
49334938
"type": "object"
@@ -8452,7 +8457,7 @@
84528457
}
84538458
}
84548459
},
8455-
"summary": "Get all notification templates.",
8460+
"summary": "Get all notification template groups.",
84568461
"tags": [
84578462
"provisioning"
84588463
]
@@ -8463,7 +8468,7 @@
84638468
"operationId": "RouteDeleteTemplate",
84648469
"parameters": [
84658470
{
8466-
"description": "Template name",
8471+
"description": "Template group name",
84678472
"in": "path",
84688473
"name": "name",
84698474
"required": true,
@@ -8487,7 +8492,7 @@
84878492
}
84888493
}
84898494
},
8490-
"summary": "Delete a template.",
8495+
"summary": "Delete a notification template group.",
84918496
"tags": [
84928497
"provisioning"
84938498
]
@@ -8496,7 +8501,7 @@
84968501
"operationId": "RouteGetTemplate",
84978502
"parameters": [
84988503
{
8499-
"description": "Template Name",
8504+
"description": "Template group name",
85008505
"in": "path",
85018506
"name": "name",
85028507
"required": true,
@@ -8517,7 +8522,7 @@
85178522
}
85188523
}
85198524
},
8520-
"summary": "Get a notification template.",
8525+
"summary": "Get a notification template group.",
85218526
"tags": [
85228527
"provisioning"
85238528
]
@@ -8529,7 +8534,7 @@
85298534
"operationId": "RoutePutTemplate",
85308535
"parameters": [
85318536
{
8532-
"description": "Template Name",
8537+
"description": "Template group name",
85338538
"in": "path",
85348539
"name": "name",
85358540
"required": true,
@@ -8568,7 +8573,7 @@
85688573
}
85698574
}
85708575
},
8571-
"summary": "Updates an existing notification template.",
8576+
"summary": "Updates an existing notification template group.",
85728577
"tags": [
85738578
"provisioning"
85748579
]

0 commit comments

Comments
 (0)