Skip to content

Commit 80f8a88

Browse files
authored
chore: update alerting swagger spec
1 parent 2c2ac09 commit 80f8a88

File tree

3 files changed

+14
-12
lines changed

3 files changed

+14
-12
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": {
@@ -4589,12 +4590,14 @@
45894590
"type": "object"
45904591
},
45914592
"gettableAlerts": {
4593+
"description": "GettableAlerts gettable alerts",
45924594
"items": {
45934595
"$ref": "#/definitions/gettableAlert"
45944596
},
45954597
"type": "array"
45964598
},
45974599
"gettableSilence": {
4600+
"description": "GettableSilence gettable silence",
45984601
"properties": {
45994602
"comment": {
46004603
"description": "comment",
@@ -4649,7 +4652,6 @@
46494652
"type": "array"
46504653
},
46514654
"integration": {
4652-
"description": "Integration integration",
46534655
"properties": {
46544656
"lastNotifyAttempt": {
46554657
"description": "A timestamp indicating the last attempt to deliver a notification regardless of the outcome.\nFormat: date-time",
@@ -4793,6 +4795,7 @@
47934795
"type": "array"
47944796
},
47954797
"postableSilence": {
4798+
"description": "PostableSilence postable silence",
47964799
"properties": {
47974800
"comment": {
47984801
"description": "comment",
@@ -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

+4-5
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,7 +4406,6 @@
44054406
"type": "object"
44064407
},
44074408
"alertGroup": {
4408-
"description": "AlertGroup alert group",
44094409
"properties": {
44104410
"alerts": {
44114411
"description": "alerts",
@@ -4590,13 +4590,13 @@
45904590
"type": "object"
45914591
},
45924592
"gettableAlerts": {
4593+
"description": "GettableAlerts gettable alerts",
45934594
"items": {
45944595
"$ref": "#/definitions/gettableAlert"
45954596
},
45964597
"type": "array"
45974598
},
45984599
"gettableSilence": {
4599-
"description": "GettableSilence gettable silence",
46004600
"properties": {
46014601
"comment": {
46024602
"description": "comment",
@@ -4645,14 +4645,12 @@
46454645
"type": "object"
46464646
},
46474647
"gettableSilences": {
4648-
"description": "GettableSilences gettable silences",
46494648
"items": {
46504649
"$ref": "#/definitions/gettableSilence"
46514650
},
46524651
"type": "array"
46534652
},
46544653
"integration": {
4655-
"description": "Integration integration",
46564654
"properties": {
46574655
"lastNotifyAttempt": {
46584656
"description": "A timestamp indicating the last attempt to deliver a notification regardless of the outcome.\nFormat: date-time",
@@ -4796,6 +4794,7 @@
47964794
"type": "array"
47974795
},
47984796
"postableSilence": {
4797+
"description": "PostableSilence postable silence",
47994798
"properties": {
48004799
"comment": {
48014800
"description": "comment",

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

+4-5
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"
@@ -7813,7 +7814,6 @@
78137814
}
78147815
},
78157816
"alertGroup": {
7816-
"description": "AlertGroup alert group",
78177817
"type": "object",
78187818
"required": [
78197819
"alerts",
@@ -8001,14 +8001,14 @@
80018001
"$ref": "#/definitions/gettableAlert"
80028002
},
80038003
"gettableAlerts": {
8004+
"description": "GettableAlerts gettable alerts",
80048005
"type": "array",
80058006
"items": {
80068007
"$ref": "#/definitions/gettableAlert"
80078008
},
80088009
"$ref": "#/definitions/gettableAlerts"
80098010
},
80108011
"gettableSilence": {
8011-
"description": "GettableSilence gettable silence",
80128012
"type": "object",
80138013
"required": [
80148014
"comment",
@@ -8058,15 +8058,13 @@
80588058
"$ref": "#/definitions/gettableSilence"
80598059
},
80608060
"gettableSilences": {
8061-
"description": "GettableSilences gettable silences",
80628061
"type": "array",
80638062
"items": {
80648063
"$ref": "#/definitions/gettableSilence"
80658064
},
80668065
"$ref": "#/definitions/gettableSilences"
80678066
},
80688067
"integration": {
8069-
"description": "Integration integration",
80708068
"type": "object",
80718069
"required": [
80728070
"name",
@@ -8211,6 +8209,7 @@
82118209
}
82128210
},
82138211
"postableSilence": {
8212+
"description": "PostableSilence postable silence",
82148213
"type": "object",
82158214
"required": [
82168215
"comment",

0 commit comments

Comments
 (0)