Skip to content

Commit 3dedcda

Browse files
authored
chore: update alerting swagger spec
1 parent 2c2ac09 commit 3dedcda

File tree

3 files changed

+12
-8
lines changed

3 files changed

+12
-8
lines changed

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

+6-2
Original file line numberDiff line numberDiff line change
@@ -4164,6 +4164,7 @@
41644164
"type": "object"
41654165
},
41664166
"URL": {
4167+
"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.",
41674168
"properties": {
41684169
"ForceQuery": {
41694170
"type": "boolean"
@@ -4199,7 +4200,7 @@
41994200
"$ref": "#/definitions/Userinfo"
42004201
}
42014202
},
4202-
"title": "URL is a custom URL type that allows validation at configuration load time.",
4203+
"title": "A URL represents a parsed URL (technically, a URI reference).",
42034204
"type": "object"
42044205
},
42054206
"UpdateRuleGroupResponse": {
@@ -4405,6 +4406,7 @@
44054406
"type": "object"
44064407
},
44074408
"alertGroup": {
4409+
"description": "AlertGroup alert group",
44084410
"properties": {
44094411
"alerts": {
44104412
"description": "alerts",
@@ -4589,12 +4591,14 @@
45894591
"type": "object"
45904592
},
45914593
"gettableAlerts": {
4594+
"description": "GettableAlerts gettable alerts",
45924595
"items": {
45934596
"$ref": "#/definitions/gettableAlert"
45944597
},
45954598
"type": "array"
45964599
},
45974600
"gettableSilence": {
4601+
"description": "GettableSilence gettable silence",
45984602
"properties": {
45994603
"comment": {
46004604
"description": "comment",
@@ -4649,7 +4653,6 @@
46494653
"type": "array"
46504654
},
46514655
"integration": {
4652-
"description": "Integration integration",
46534656
"properties": {
46544657
"lastNotifyAttempt": {
46554658
"description": "A timestamp indicating the last attempt to deliver a notification regardless of the outcome.\nFormat: date-time",
@@ -4830,6 +4833,7 @@
48304833
"type": "object"
48314834
},
48324835
"receiver": {
4836+
"description": "Receiver receiver",
48334837
"properties": {
48344838
"active": {
48354839
"description": "active",

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -4164,6 +4164,7 @@
41644164
"type": "object"
41654165
},
41664166
"URL": {
4167+
"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.",
41674168
"properties": {
41684169
"ForceQuery": {
41694170
"type": "boolean"
@@ -4199,7 +4200,7 @@
41994200
"$ref": "#/definitions/Userinfo"
42004201
}
42014202
},
4202-
"title": "URL is a custom URL type that allows validation at configuration load time.",
4203+
"title": "A URL represents a parsed URL (technically, a URI reference).",
42034204
"type": "object"
42044205
},
42054206
"UpdateRuleGroupResponse": {
@@ -4429,7 +4430,6 @@
44294430
"type": "object"
44304431
},
44314432
"alertGroups": {
4432-
"description": "AlertGroups alert groups",
44334433
"items": {
44344434
"$ref": "#/definitions/alertGroup"
44354435
},
@@ -4590,6 +4590,7 @@
45904590
"type": "object"
45914591
},
45924592
"gettableAlerts": {
4593+
"description": "GettableAlerts gettable alerts",
45934594
"items": {
45944595
"$ref": "#/definitions/gettableAlert"
45954596
},
@@ -4645,7 +4646,6 @@
46454646
"type": "object"
46464647
},
46474648
"gettableSilences": {
4648-
"description": "GettableSilences gettable silences",
46494649
"items": {
46504650
"$ref": "#/definitions/gettableSilence"
46514651
},

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -7572,8 +7572,9 @@
75727572
}
75737573
},
75747574
"URL": {
7575+
"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.",
75757576
"type": "object",
7576-
"title": "URL is a custom URL type that allows validation at configuration load time.",
7577+
"title": "A URL represents a parsed URL (technically, a URI reference).",
75777578
"properties": {
75787579
"ForceQuery": {
75797580
"type": "boolean"
@@ -7838,7 +7839,6 @@
78387839
"$ref": "#/definitions/alertGroup"
78397840
},
78407841
"alertGroups": {
7841-
"description": "AlertGroups alert groups",
78427842
"type": "array",
78437843
"items": {
78447844
"$ref": "#/definitions/alertGroup"
@@ -8001,6 +8001,7 @@
80018001
"$ref": "#/definitions/gettableAlert"
80028002
},
80038003
"gettableAlerts": {
8004+
"description": "GettableAlerts gettable alerts",
80048005
"type": "array",
80058006
"items": {
80068007
"$ref": "#/definitions/gettableAlert"
@@ -8058,7 +8059,6 @@
80588059
"$ref": "#/definitions/gettableSilence"
80598060
},
80608061
"gettableSilences": {
8061-
"description": "GettableSilences gettable silences",
80628062
"type": "array",
80638063
"items": {
80648064
"$ref": "#/definitions/gettableSilence"

0 commit comments

Comments
 (0)