Skip to content

Commit f1c56b4

Browse files
chore: update alerting swagger spec
1 parent 7ac2fd7 commit f1c56b4

File tree

3 files changed

+8
-9
lines changed

3 files changed

+8
-9
lines changed

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

-3
Original file line numberDiff line numberDiff line change
@@ -4229,7 +4229,6 @@
42294229
"type": "object"
42304230
},
42314231
"alertGroup": {
4232-
"description": "AlertGroup alert group",
42334232
"properties": {
42344233
"alerts": {
42354234
"description": "alerts",
@@ -4253,7 +4252,6 @@
42534252
"type": "object"
42544253
},
42554254
"alertGroups": {
4256-
"description": "AlertGroups alert groups",
42574255
"items": {
42584256
"$ref": "#/definitions/alertGroup"
42594257
},
@@ -4475,7 +4473,6 @@
44754473
"type": "array"
44764474
},
44774475
"integration": {
4478-
"description": "Integration integration",
44794476
"properties": {
44804477
"lastNotifyAttempt": {
44814478
"description": "A timestamp indicating the last attempt to deliver a notification regardless of the outcome.\nFormat: date-time",

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

+4-3
Original file line numberDiff line numberDiff line change
@@ -3988,7 +3988,6 @@
39883988
"type": "object"
39893989
},
39903990
"URL": {
3991-
"description": "The general form represented is:\n\n[scheme:][//[userinfo@]host][/]path[?query][#fragment]\n\nURLs that do not start with a slash after the scheme are interpreted as:\n\nscheme:opaque[?query][#fragment]\n\nNote that the Path field is stored in decoded form: /%47%6f%2f becomes /Go/.\nA consequence is that it is impossible to tell which slashes in the Path were\nslashes in the raw URL and which were %2f. This distinction is rarely important,\nbut when it is, the code should use the EscapedPath method, which preserves\nthe original encoding of Path.\n\nThe RawPath field is an optional field which is only set when the default\nencoding of Path is different from the escaped path. See the EscapedPath method\nfor more details.\n\nURL's String method uses the EscapedPath method to obtain the path.",
39923991
"properties": {
39933992
"ForceQuery": {
39943993
"type": "boolean"
@@ -4024,7 +4023,7 @@
40244023
"$ref": "#/definitions/Userinfo"
40254024
}
40264025
},
4027-
"title": "A URL represents a parsed URL (technically, a URI reference).",
4026+
"title": "URL is a custom URL type that allows validation at configuration load time.",
40284027
"type": "object"
40294028
},
40304029
"UpdateRuleGroupResponse": {
@@ -4254,6 +4253,7 @@
42544253
"type": "object"
42554254
},
42564255
"alertGroups": {
4256+
"description": "AlertGroups alert groups",
42574257
"items": {
42584258
"$ref": "#/definitions/alertGroup"
42594259
},
@@ -4358,6 +4358,7 @@
43584358
"type": "object"
43594359
},
43604360
"gettableAlert": {
4361+
"description": "GettableAlert gettable alert",
43614362
"properties": {
43624363
"annotations": {
43634364
"$ref": "#/definitions/labelSet"
@@ -4474,7 +4475,6 @@
44744475
"type": "array"
44754476
},
44764477
"integration": {
4477-
"description": "Integration integration",
44784478
"properties": {
44794479
"lastNotifyAttempt": {
44804480
"description": "A timestamp indicating the last attempt to deliver a notification regardless of the outcome.\nFormat: date-time",
@@ -4655,6 +4655,7 @@
46554655
"type": "object"
46564656
},
46574657
"receiver": {
4658+
"description": "Receiver receiver",
46584659
"properties": {
46594660
"active": {
46604661
"description": "active",

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

+4-3
Original file line numberDiff line numberDiff line change
@@ -7141,9 +7141,8 @@
71417141
}
71427142
},
71437143
"URL": {
7144-
"description": "The general form represented is:\n\n[scheme:][//[userinfo@]host][/]path[?query][#fragment]\n\nURLs that do not start with a slash after the scheme are interpreted as:\n\nscheme:opaque[?query][#fragment]\n\nNote that the Path field is stored in decoded form: /%47%6f%2f becomes /Go/.\nA consequence is that it is impossible to tell which slashes in the Path were\nslashes in the raw URL and which were %2f. This distinction is rarely important,\nbut when it is, the code should use the EscapedPath method, which preserves\nthe original encoding of Path.\n\nThe RawPath field is an optional field which is only set when the default\nencoding of Path is different from the escaped path. See the EscapedPath method\nfor more details.\n\nURL's String method uses the EscapedPath method to obtain the path.",
71457144
"type": "object",
7146-
"title": "A URL represents a parsed URL (technically, a URI reference).",
7145+
"title": "URL is a custom URL type that allows validation at configuration load time.",
71477146
"properties": {
71487147
"ForceQuery": {
71497148
"type": "boolean"
@@ -7408,6 +7407,7 @@
74087407
"$ref": "#/definitions/alertGroup"
74097408
},
74107409
"alertGroups": {
7410+
"description": "AlertGroups alert groups",
74117411
"type": "array",
74127412
"items": {
74137413
"$ref": "#/definitions/alertGroup"
@@ -7513,6 +7513,7 @@
75137513
}
75147514
},
75157515
"gettableAlert": {
7516+
"description": "GettableAlert gettable alert",
75167517
"type": "object",
75177518
"required": [
75187519
"labels",
@@ -7633,7 +7634,6 @@
76337634
"$ref": "#/definitions/gettableSilences"
76347635
},
76357636
"integration": {
7636-
"description": "Integration integration",
76377637
"type": "object",
76387638
"required": [
76397639
"name",
@@ -7816,6 +7816,7 @@
78167816
"$ref": "#/definitions/postableSilence"
78177817
},
78187818
"receiver": {
7819+
"description": "Receiver receiver",
78197820
"type": "object",
78207821
"required": [
78217822
"active",

0 commit comments

Comments
 (0)