Alerting: Regenerate swagger spec (#98914)

pull/98923/head
Matthew Jacobson 6 months ago committed by GitHub
parent 766d645d82
commit 6883a4b294
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
  1. 65
      pkg/services/ngalert/api/tooling/api.json
  2. 66
      pkg/services/ngalert/api/tooling/post.json
  3. 66
      pkg/services/ngalert/api/tooling/spec.json
  4. 59
      public/api-merged.json
  5. 59
      public/openapi3.json

@ -165,6 +165,9 @@
}, },
"AlertRuleEditorSettings": { "AlertRuleEditorSettings": {
"properties": { "properties": {
"simplified_notifications_section": {
"type": "boolean"
},
"simplified_query_and_expressions_section": { "simplified_query_and_expressions_section": {
"type": "boolean" "type": "boolean"
} }
@ -755,7 +758,7 @@
"type": "string" "type": "string"
}, },
"ErrorSource": { "ErrorSource": {
"$ref": "#/definitions/ErrorSource" "$ref": "#/definitions/Source"
}, },
"Frames": { "Frames": {
"$ref": "#/definitions/Frames" "$ref": "#/definitions/Frames"
@ -895,23 +898,23 @@
"type": { "type": {
"enum": [ "enum": [
"alertmanager", "alertmanager",
" dingding", "dingding",
" discord", "discord",
" email", "email",
" googlechat", "googlechat",
" kafka", "kafka",
" line", "line",
" opsgenie", "opsgenie",
" pagerduty", "pagerduty",
" pushover", "pushover",
" sensugo", "sensugo",
" slack", "slack",
" teams", "teams",
" telegram", "telegram",
" threema", "threema",
" victorops", "victorops",
" webhook", "webhook",
" wecom" "wecom"
], ],
"example": "webhook", "example": "webhook",
"type": "string" "type": "string"
@ -965,10 +968,6 @@
}, },
"type": "object" "type": "object"
}, },
"ErrorSource": {
"description": "ErrorSource type defines the source of the error",
"type": "string"
},
"ErrorType": { "ErrorType": {
"title": "ErrorType models the different API error types.", "title": "ErrorType models the different API error types.",
"type": "string" "type": "string"
@ -3606,6 +3605,9 @@
}, },
"RuleDiscovery": { "RuleDiscovery": {
"properties": { "properties": {
"groupNextToken": {
"type": "string"
},
"groups": { "groups": {
"items": { "items": {
"$ref": "#/definitions/RuleGroup" "$ref": "#/definitions/RuleGroup"
@ -3975,6 +3977,10 @@
"SmtpNotEnabled": { "SmtpNotEnabled": {
"$ref": "#/definitions/ResponseDetails" "$ref": "#/definitions/ResponseDetails"
}, },
"Source": {
"title": "Source type defines the status source.",
"type": "string"
},
"Span": { "Span": {
"properties": { "properties": {
"Length": { "Length": {
@ -4803,6 +4809,7 @@
"type": "object" "type": "object"
}, },
"gettableAlerts": { "gettableAlerts": {
"description": "GettableAlerts gettable alerts",
"items": { "items": {
"$ref": "#/definitions/gettableAlert", "$ref": "#/definitions/gettableAlert",
"type": "object" "type": "object"
@ -6240,7 +6247,7 @@
} }
} }
}, },
"summary": "Get all notification templates.", "summary": "Get all notification template groups.",
"tags": [ "tags": [
"provisioning" "provisioning"
] ]
@ -6251,7 +6258,7 @@
"operationId": "RouteDeleteTemplate", "operationId": "RouteDeleteTemplate",
"parameters": [ "parameters": [
{ {
"description": "Template name", "description": "Template group name",
"in": "path", "in": "path",
"name": "name", "name": "name",
"required": true, "required": true,
@ -6275,7 +6282,7 @@
} }
} }
}, },
"summary": "Delete a template.", "summary": "Delete a notification template group.",
"tags": [ "tags": [
"provisioning" "provisioning"
] ]
@ -6284,7 +6291,7 @@
"operationId": "RouteGetTemplate", "operationId": "RouteGetTemplate",
"parameters": [ "parameters": [
{ {
"description": "Template Name", "description": "Template group name",
"in": "path", "in": "path",
"name": "name", "name": "name",
"required": true, "required": true,
@ -6305,7 +6312,7 @@
} }
} }
}, },
"summary": "Get a notification template.", "summary": "Get a notification template group.",
"tags": [ "tags": [
"provisioning" "provisioning"
] ]
@ -6317,7 +6324,7 @@
"operationId": "RoutePutTemplate", "operationId": "RoutePutTemplate",
"parameters": [ "parameters": [
{ {
"description": "Template Name", "description": "Template group name",
"in": "path", "in": "path",
"name": "name", "name": "name",
"required": true, "required": true,
@ -6356,7 +6363,7 @@
} }
} }
}, },
"summary": "Updates an existing notification template.", "summary": "Updates an existing notification template group.",
"tags": [ "tags": [
"provisioning" "provisioning"
] ]

@ -165,6 +165,9 @@
}, },
"AlertRuleEditorSettings": { "AlertRuleEditorSettings": {
"properties": { "properties": {
"simplified_notifications_section": {
"type": "boolean"
},
"simplified_query_and_expressions_section": { "simplified_query_and_expressions_section": {
"type": "boolean" "type": "boolean"
} }
@ -755,7 +758,7 @@
"type": "string" "type": "string"
}, },
"ErrorSource": { "ErrorSource": {
"$ref": "#/definitions/ErrorSource" "$ref": "#/definitions/Source"
}, },
"Frames": { "Frames": {
"$ref": "#/definitions/Frames" "$ref": "#/definitions/Frames"
@ -895,23 +898,23 @@
"type": { "type": {
"enum": [ "enum": [
"alertmanager", "alertmanager",
" dingding", "dingding",
" discord", "discord",
" email", "email",
" googlechat", "googlechat",
" kafka", "kafka",
" line", "line",
" opsgenie", "opsgenie",
" pagerduty", "pagerduty",
" pushover", "pushover",
" sensugo", "sensugo",
" slack", "slack",
" teams", "teams",
" telegram", "telegram",
" threema", "threema",
" victorops", "victorops",
" webhook", "webhook",
" wecom" "wecom"
], ],
"example": "webhook", "example": "webhook",
"type": "string" "type": "string"
@ -965,10 +968,6 @@
}, },
"type": "object" "type": "object"
}, },
"ErrorSource": {
"description": "ErrorSource type defines the source of the error",
"type": "string"
},
"ErrorType": { "ErrorType": {
"title": "ErrorType models the different API error types.", "title": "ErrorType models the different API error types.",
"type": "string" "type": "string"
@ -3606,6 +3605,9 @@
}, },
"RuleDiscovery": { "RuleDiscovery": {
"properties": { "properties": {
"groupNextToken": {
"type": "string"
},
"groups": { "groups": {
"items": { "items": {
"$ref": "#/definitions/RuleGroup" "$ref": "#/definitions/RuleGroup"
@ -3975,6 +3977,10 @@
"SmtpNotEnabled": { "SmtpNotEnabled": {
"$ref": "#/definitions/ResponseDetails" "$ref": "#/definitions/ResponseDetails"
}, },
"Source": {
"title": "Source type defines the status source.",
"type": "string"
},
"Span": { "Span": {
"properties": { "properties": {
"Length": { "Length": {
@ -4802,7 +4808,6 @@
"type": "object" "type": "object"
}, },
"gettableAlerts": { "gettableAlerts": {
"description": "GettableAlerts gettable alerts",
"items": { "items": {
"$ref": "#/definitions/gettableAlert", "$ref": "#/definitions/gettableAlert",
"type": "object" "type": "object"
@ -4927,7 +4932,6 @@
"type": "object" "type": "object"
}, },
"gettableSilences": { "gettableSilences": {
"description": "GettableSilences gettable silences",
"items": { "items": {
"$ref": "#/definitions/gettableSilence", "$ref": "#/definitions/gettableSilence",
"type": "object" "type": "object"
@ -8452,7 +8456,7 @@
} }
} }
}, },
"summary": "Get all notification templates.", "summary": "Get all notification template groups.",
"tags": [ "tags": [
"provisioning" "provisioning"
] ]
@ -8463,7 +8467,7 @@
"operationId": "RouteDeleteTemplate", "operationId": "RouteDeleteTemplate",
"parameters": [ "parameters": [
{ {
"description": "Template name", "description": "Template group name",
"in": "path", "in": "path",
"name": "name", "name": "name",
"required": true, "required": true,
@ -8487,7 +8491,7 @@
} }
} }
}, },
"summary": "Delete a template.", "summary": "Delete a notification template group.",
"tags": [ "tags": [
"provisioning" "provisioning"
] ]
@ -8496,7 +8500,7 @@
"operationId": "RouteGetTemplate", "operationId": "RouteGetTemplate",
"parameters": [ "parameters": [
{ {
"description": "Template Name", "description": "Template group name",
"in": "path", "in": "path",
"name": "name", "name": "name",
"required": true, "required": true,
@ -8517,7 +8521,7 @@
} }
} }
}, },
"summary": "Get a notification template.", "summary": "Get a notification template group.",
"tags": [ "tags": [
"provisioning" "provisioning"
] ]
@ -8529,7 +8533,7 @@
"operationId": "RoutePutTemplate", "operationId": "RoutePutTemplate",
"parameters": [ "parameters": [
{ {
"description": "Template Name", "description": "Template group name",
"in": "path", "in": "path",
"name": "name", "name": "name",
"required": true, "required": true,
@ -8568,7 +8572,7 @@
} }
} }
}, },
"summary": "Updates an existing notification template.", "summary": "Updates an existing notification template group.",
"tags": [ "tags": [
"provisioning" "provisioning"
] ]

@ -3306,7 +3306,7 @@
"provisioning", "provisioning",
"stable" "stable"
], ],
"summary": "Get all notification templates.", "summary": "Get all notification template groups.",
"operationId": "RouteGetTemplates", "operationId": "RouteGetTemplates",
"responses": { "responses": {
"200": { "200": {
@ -3324,12 +3324,12 @@
"provisioning", "provisioning",
"stable" "stable"
], ],
"summary": "Get a notification template.", "summary": "Get a notification template group.",
"operationId": "RouteGetTemplate", "operationId": "RouteGetTemplate",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"description": "Template Name", "description": "Template group name",
"name": "name", "name": "name",
"in": "path", "in": "path",
"required": true "required": true
@ -3358,12 +3358,12 @@
"provisioning", "provisioning",
"stable" "stable"
], ],
"summary": "Updates an existing notification template.", "summary": "Updates an existing notification template group.",
"operationId": "RoutePutTemplate", "operationId": "RoutePutTemplate",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"description": "Template Name", "description": "Template group name",
"name": "name", "name": "name",
"in": "path", "in": "path",
"required": true "required": true
@ -3407,12 +3407,12 @@
"provisioning", "provisioning",
"stable" "stable"
], ],
"summary": "Delete a template.", "summary": "Delete a notification template group.",
"operationId": "RouteDeleteTemplate", "operationId": "RouteDeleteTemplate",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"description": "Template name", "description": "Template group name",
"name": "name", "name": "name",
"in": "path", "in": "path",
"required": true "required": true
@ -3797,6 +3797,9 @@
"AlertRuleEditorSettings": { "AlertRuleEditorSettings": {
"type": "object", "type": "object",
"properties": { "properties": {
"simplified_notifications_section": {
"type": "boolean"
},
"simplified_query_and_expressions_section": { "simplified_query_and_expressions_section": {
"type": "boolean" "type": "boolean"
} }
@ -4388,7 +4391,7 @@
"type": "string" "type": "string"
}, },
"ErrorSource": { "ErrorSource": {
"$ref": "#/definitions/ErrorSource" "$ref": "#/definitions/Source"
}, },
"Frames": { "Frames": {
"$ref": "#/definitions/Frames" "$ref": "#/definitions/Frames"
@ -4533,23 +4536,23 @@
"type": "string", "type": "string",
"enum": [ "enum": [
"alertmanager", "alertmanager",
" dingding", "dingding",
" discord", "discord",
" email", "email",
" googlechat", "googlechat",
" kafka", "kafka",
" line", "line",
" opsgenie", "opsgenie",
" pagerduty", "pagerduty",
" pushover", "pushover",
" sensugo", "sensugo",
" slack", "slack",
" teams", "teams",
" telegram", "telegram",
" threema", "threema",
" victorops", "victorops",
" webhook", "webhook",
" wecom" "wecom"
], ],
"example": "webhook" "example": "webhook"
}, },
@ -4597,10 +4600,6 @@
} }
} }
}, },
"ErrorSource": {
"description": "ErrorSource type defines the source of the error",
"type": "string"
},
"ErrorType": { "ErrorType": {
"type": "string", "type": "string",
"title": "ErrorType models the different API error types." "title": "ErrorType models the different API error types."
@ -7243,6 +7242,9 @@
"groups" "groups"
], ],
"properties": { "properties": {
"groupNextToken": {
"type": "string"
},
"groups": { "groups": {
"type": "array", "type": "array",
"items": { "items": {
@ -7608,6 +7610,10 @@
"SmtpNotEnabled": { "SmtpNotEnabled": {
"$ref": "#/definitions/ResponseDetails" "$ref": "#/definitions/ResponseDetails"
}, },
"Source": {
"type": "string",
"title": "Source type defines the status source."
},
"Span": { "Span": {
"type": "object", "type": "object",
"title": "A Span defines a continuous sequence of buckets.", "title": "A Span defines a continuous sequence of buckets.",
@ -8435,7 +8441,6 @@
} }
}, },
"gettableAlerts": { "gettableAlerts": {
"description": "GettableAlerts gettable alerts",
"type": "array", "type": "array",
"items": { "items": {
"type": "object", "type": "object",
@ -8560,7 +8565,6 @@
} }
}, },
"gettableSilences": { "gettableSilences": {
"description": "GettableSilences gettable silences",
"type": "array", "type": "array",
"items": { "items": {
"type": "object", "type": "object",

@ -11783,7 +11783,7 @@
"tags": [ "tags": [
"provisioning" "provisioning"
], ],
"summary": "Get all notification templates.", "summary": "Get all notification template groups.",
"operationId": "RouteGetTemplates", "operationId": "RouteGetTemplates",
"responses": { "responses": {
"200": { "200": {
@ -11800,12 +11800,12 @@
"tags": [ "tags": [
"provisioning" "provisioning"
], ],
"summary": "Get a notification template.", "summary": "Get a notification template group.",
"operationId": "RouteGetTemplate", "operationId": "RouteGetTemplate",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"description": "Template Name", "description": "Template group name",
"name": "name", "name": "name",
"in": "path", "in": "path",
"required": true "required": true
@ -11833,12 +11833,12 @@
"tags": [ "tags": [
"provisioning" "provisioning"
], ],
"summary": "Updates an existing notification template.", "summary": "Updates an existing notification template group.",
"operationId": "RoutePutTemplate", "operationId": "RoutePutTemplate",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"description": "Template Name", "description": "Template group name",
"name": "name", "name": "name",
"in": "path", "in": "path",
"required": true "required": true
@ -11881,12 +11881,12 @@
"tags": [ "tags": [
"provisioning" "provisioning"
], ],
"summary": "Delete a template.", "summary": "Delete a notification template group.",
"operationId": "RouteDeleteTemplate", "operationId": "RouteDeleteTemplate",
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"description": "Template name", "description": "Template group name",
"name": "name", "name": "name",
"in": "path", "in": "path",
"required": true "required": true
@ -12588,6 +12588,9 @@
"AlertRuleEditorSettings": { "AlertRuleEditorSettings": {
"type": "object", "type": "object",
"properties": { "properties": {
"simplified_notifications_section": {
"type": "boolean"
},
"simplified_query_and_expressions_section": { "simplified_query_and_expressions_section": {
"type": "boolean" "type": "boolean"
} }
@ -15067,23 +15070,23 @@
"type": "string", "type": "string",
"enum": [ "enum": [
"alertmanager", "alertmanager",
" dingding", "dingding",
" discord", "discord",
" email", "email",
" googlechat", "googlechat",
" kafka", "kafka",
" line", "line",
" opsgenie", "opsgenie",
" pagerduty", "pagerduty",
" pushover", "pushover",
" sensugo", "sensugo",
" slack", "slack",
" teams", "teams",
" telegram", "telegram",
" threema", "threema",
" victorops", "victorops",
" webhook", "webhook",
" wecom" "wecom"
], ],
"example": "webhook" "example": "webhook"
}, },
@ -15151,10 +15154,6 @@
} }
} }
}, },
"ErrorSource": {
"description": "ErrorSource type defines the source of the error",
"type": "string"
},
"ErrorType": { "ErrorType": {
"type": "string", "type": "string",
"title": "ErrorType models the different API error types." "title": "ErrorType models the different API error types."
@ -19857,6 +19856,9 @@
"groups" "groups"
], ],
"properties": { "properties": {
"groupNextToken": {
"type": "string"
},
"groups": { "groups": {
"type": "array", "type": "array",
"items": { "items": {
@ -22645,6 +22647,7 @@
} }
}, },
"gettableAlerts": { "gettableAlerts": {
"description": "GettableAlerts gettable alerts",
"type": "array", "type": "array",
"items": { "items": {
"type": "object", "type": "object",

@ -2662,6 +2662,9 @@
}, },
"AlertRuleEditorSettings": { "AlertRuleEditorSettings": {
"properties": { "properties": {
"simplified_notifications_section": {
"type": "boolean"
},
"simplified_query_and_expressions_section": { "simplified_query_and_expressions_section": {
"type": "boolean" "type": "boolean"
} }
@ -5136,23 +5139,23 @@
"type": { "type": {
"enum": [ "enum": [
"alertmanager", "alertmanager",
" dingding", "dingding",
" discord", "discord",
" email", "email",
" googlechat", "googlechat",
" kafka", "kafka",
" line", "line",
" opsgenie", "opsgenie",
" pagerduty", "pagerduty",
" pushover", "pushover",
" sensugo", "sensugo",
" slack", "slack",
" teams", "teams",
" telegram", "telegram",
" threema", "threema",
" victorops", "victorops",
" webhook", "webhook",
" wecom" "wecom"
], ],
"example": "webhook", "example": "webhook",
"type": "string" "type": "string"
@ -5226,10 +5229,6 @@
], ],
"type": "object" "type": "object"
}, },
"ErrorSource": {
"description": "ErrorSource type defines the source of the error",
"type": "string"
},
"ErrorType": { "ErrorType": {
"title": "ErrorType models the different API error types.", "title": "ErrorType models the different API error types.",
"type": "string" "type": "string"
@ -9928,6 +9927,9 @@
}, },
"RuleDiscovery": { "RuleDiscovery": {
"properties": { "properties": {
"groupNextToken": {
"type": "string"
},
"groups": { "groups": {
"items": { "items": {
"$ref": "#/components/schemas/RuleGroup" "$ref": "#/components/schemas/RuleGroup"
@ -12718,6 +12720,7 @@
"type": "object" "type": "object"
}, },
"gettableAlerts": { "gettableAlerts": {
"description": "GettableAlerts gettable alerts",
"items": { "items": {
"$ref": "#/components/schemas/gettableAlert" "$ref": "#/components/schemas/gettableAlert"
}, },
@ -26239,7 +26242,7 @@
"description": "NotificationTemplates" "description": "NotificationTemplates"
} }
}, },
"summary": "Get all notification templates.", "summary": "Get all notification template groups.",
"tags": [ "tags": [
"provisioning" "provisioning"
] ]
@ -26250,7 +26253,7 @@
"operationId": "RouteDeleteTemplate", "operationId": "RouteDeleteTemplate",
"parameters": [ "parameters": [
{ {
"description": "Template name", "description": "Template group name",
"in": "path", "in": "path",
"name": "name", "name": "name",
"required": true, "required": true,
@ -26282,7 +26285,7 @@
"description": "PublicError" "description": "PublicError"
} }
}, },
"summary": "Delete a template.", "summary": "Delete a notification template group.",
"tags": [ "tags": [
"provisioning" "provisioning"
] ]
@ -26291,7 +26294,7 @@
"operationId": "RouteGetTemplate", "operationId": "RouteGetTemplate",
"parameters": [ "parameters": [
{ {
"description": "Template Name", "description": "Template group name",
"in": "path", "in": "path",
"name": "name", "name": "name",
"required": true, "required": true,
@ -26322,7 +26325,7 @@
"description": "PublicError" "description": "PublicError"
} }
}, },
"summary": "Get a notification template.", "summary": "Get a notification template group.",
"tags": [ "tags": [
"provisioning" "provisioning"
] ]
@ -26331,7 +26334,7 @@
"operationId": "RoutePutTemplate", "operationId": "RoutePutTemplate",
"parameters": [ "parameters": [
{ {
"description": "Template Name", "description": "Template group name",
"in": "path", "in": "path",
"name": "name", "name": "name",
"required": true, "required": true,
@ -26389,7 +26392,7 @@
"description": "PublicError" "description": "PublicError"
} }
}, },
"summary": "Updates an existing notification template.", "summary": "Updates an existing notification template group.",
"tags": [ "tags": [
"provisioning" "provisioning"
] ]

Loading…
Cancel
Save