Skip to content

Commit ab60c15

Browse files
authored
chore: update alerting swagger spec
1 parent fdb4626 commit ab60c15

File tree

3 files changed

+7
-9
lines changed

3 files changed

+7
-9
lines changed

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4228,7 +4228,6 @@
42284228
"type": "object"
42294229
},
42304230
"alertGroups": {
4231-
"description": "AlertGroups alert groups",
42324231
"items": {
42334232
"$ref": "#/definitions/alertGroup"
42344233
},
@@ -4333,6 +4332,7 @@
43334332
"type": "object"
43344333
},
43354334
"gettableAlert": {
4335+
"description": "GettableAlert gettable alert",
43364336
"properties": {
43374337
"annotations": {
43384338
"$ref": "#/definitions/labelSet"
@@ -4395,7 +4395,6 @@
43954395
"type": "array"
43964396
},
43974397
"gettableSilence": {
4398-
"description": "GettableSilence gettable silence",
43994398
"properties": {
44004399
"comment": {
44014400
"description": "comment",
@@ -4444,14 +4443,12 @@
44444443
"type": "object"
44454444
},
44464445
"gettableSilences": {
4447-
"description": "GettableSilences gettable silences",
44484446
"items": {
44494447
"$ref": "#/definitions/gettableSilence"
44504448
},
44514449
"type": "array"
44524450
},
44534451
"integration": {
4454-
"description": "Integration integration",
44554452
"properties": {
44564453
"lastNotifyAttempt": {
44574454
"description": "A timestamp indicating the last attempt to deliver a notification regardless of the outcome.\nFormat: date-time",
@@ -4632,7 +4629,6 @@
46324629
"type": "object"
46334630
},
46344631
"receiver": {
4635-
"description": "Receiver receiver",
46364632
"properties": {
46374633
"active": {
46384634
"description": "active",

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3964,6 +3964,7 @@
39643964
"type": "object"
39653965
},
39663966
"URL": {
3967+
"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.",
39673968
"properties": {
39683969
"ForceQuery": {
39693970
"type": "boolean"
@@ -3999,7 +4000,7 @@
39994000
"$ref": "#/definitions/Userinfo"
40004001
}
40014002
},
4002-
"title": "URL is a custom URL type that allows validation at configuration load time.",
4003+
"title": "A URL represents a parsed URL (technically, a URI reference).",
40034004
"type": "object"
40044005
},
40054006
"UpdateRuleGroupResponse": {
@@ -4396,6 +4397,7 @@
43964397
"type": "array"
43974398
},
43984399
"gettableSilence": {
4400+
"description": "GettableSilence gettable silence",
43994401
"properties": {
44004402
"comment": {
44014403
"description": "comment",
@@ -4451,7 +4453,6 @@
44514453
"type": "array"
44524454
},
44534455
"integration": {
4454-
"description": "Integration integration",
44554456
"properties": {
44564457
"lastNotifyAttempt": {
44574458
"description": "A timestamp indicating the last attempt to deliver a notification regardless of the outcome.\nFormat: date-time",

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7030,8 +7030,9 @@
70307030
}
70317031
},
70327032
"URL": {
7033+
"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.",
70337034
"type": "object",
7034-
"title": "URL is a custom URL type that allows validation at configuration load time.",
7035+
"title": "A URL represents a parsed URL (technically, a URI reference).",
70357036
"properties": {
70367037
"ForceQuery": {
70377038
"type": "boolean"
@@ -7466,6 +7467,7 @@
74667467
"$ref": "#/definitions/gettableAlerts"
74677468
},
74687469
"gettableSilence": {
7470+
"description": "GettableSilence gettable silence",
74697471
"type": "object",
74707472
"required": [
74717473
"comment",
@@ -7523,7 +7525,6 @@
75237525
"$ref": "#/definitions/gettableSilences"
75247526
},
75257527
"integration": {
7526-
"description": "Integration integration",
75277528
"type": "object",
75287529
"required": [
75297530
"name",

0 commit comments

Comments
 (0)