Alerting: Fix swagger specification (#49273)

* Alerting: fix specification

* Update merged swagger specification
This commit is contained in:
Sofia Papagiannaki
2022-05-26 14:43:59 +03:00
committed by GitHub
parent a95ba8eb3f
commit 7cf321d7bd
10 changed files with 481 additions and 1900 deletions
+151 -14
View File
@@ -1164,7 +1164,10 @@
],
"responses": {
"202": {
"$ref": "#/responses/Accepted"
"description": "Ack",
"schema": {
"$ref": "#/definitions/Ack"
}
},
"400": {
"description": "ValidationError",
@@ -1186,6 +1189,13 @@
"summary": "Update an existing contact point.",
"operationId": "RoutePutContactpoint",
"parameters": [
{
"type": "string",
"description": "ContactPointUID should be the contact point UID identifier",
"name": "ID",
"in": "path",
"required": true
},
{
"name": "Body",
"in": "body",
@@ -1196,7 +1206,10 @@
],
"responses": {
"202": {
"$ref": "#/responses/Accepted"
"description": "Ack",
"schema": {
"$ref": "#/definitions/Ack"
}
},
"400": {
"description": "ValidationError",
@@ -1215,9 +1228,21 @@
],
"summary": "Delete a contact point.",
"operationId": "RouteDeleteContactpoints",
"parameters": [
{
"type": "string",
"description": "ContactPointUID should be the contact point UID identifier",
"name": "ID",
"in": "path",
"required": true
}
],
"responses": {
"202": {
"$ref": "#/responses/Accepted"
"description": "Ack",
"schema": {
"$ref": "#/definitions/Ack"
}
},
"400": {
"description": "ValidationError",
@@ -1237,7 +1262,10 @@
"operationId": "RouteGetMuteTimings",
"responses": {
"200": {
"$ref": "#/responses/MuteTiming"
"description": "MuteTimings",
"schema": {
"$ref": "#/definitions/MuteTimings"
}
},
"400": {
"description": "ValidationError",
@@ -1255,9 +1283,22 @@
],
"summary": "Get a mute timing.",
"operationId": "RouteGetMuteTiming",
"parameters": [
{
"type": "string",
"x-go-name": "Name",
"description": "Template Name",
"name": "name",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"$ref": "#/responses/MuteTiming"
"description": "MuteTiming",
"schema": {
"$ref": "#/definitions/MuteTiming"
}
},
"400": {
"description": "ValidationError",
@@ -1310,7 +1351,10 @@
],
"responses": {
"202": {
"$ref": "#/responses/Accepted"
"description": "Ack",
"schema": {
"$ref": "#/definitions/Ack"
}
},
"400": {
"description": "ValidationError",
@@ -1330,7 +1374,10 @@
"operationId": "RouteGetTemplates",
"responses": {
"200": {
"$ref": "#/responses/MessageTemplate"
"description": "MessageTemplate",
"schema": {
"$ref": "#/definitions/MessageTemplate"
}
},
"400": {
"description": "ValidationError",
@@ -1348,12 +1395,28 @@
],
"summary": "Get a message template.",
"operationId": "RouteGetTemplate",
"parameters": [
{
"type": "string",
"x-go-name": "Name",
"description": "Template Name",
"name": "name",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"$ref": "#/responses/MessageTemplate"
"description": "MessageTemplate",
"schema": {
"$ref": "#/definitions/MessageTemplate"
}
},
"404": {
"$ref": "#/responses/NotFound"
"description": "NotFound",
"schema": {
"$ref": "#/definitions/NotFound"
}
}
}
},
@@ -1367,6 +1430,14 @@
"summary": "Updates an existing template.",
"operationId": "RoutePutTemplate",
"parameters": [
{
"type": "string",
"x-go-name": "Name",
"description": "Template Name",
"name": "name",
"in": "path",
"required": true
},
{
"name": "Body",
"in": "body",
@@ -1377,7 +1448,10 @@
],
"responses": {
"202": {
"$ref": "#/responses/Accepted"
"description": "Ack",
"schema": {
"$ref": "#/definitions/Ack"
}
},
"400": {
"description": "ValidationError",
@@ -1393,9 +1467,22 @@
],
"summary": "Delete a template.",
"operationId": "RouteDeleteTemplate",
"parameters": [
{
"type": "string",
"x-go-name": "Name",
"description": "Template Name",
"name": "name",
"in": "path",
"required": true
}
],
"responses": {
"204": {
"$ref": "#/responses/Accepted"
"description": "Ack",
"schema": {
"$ref": "#/definitions/Ack"
}
}
}
}
@@ -3389,6 +3476,21 @@
},
"$ref": "#/definitions/Matchers"
},
"MessageTemplate": {
"type": "object",
"properties": {
"Name": {
"type": "string"
},
"Template": {
"type": "string"
},
"provenance": {
"$ref": "#/definitions/Provenance"
}
},
"x-go-package": "github.com/grafana/grafana/pkg/services/ngalert/api/tooling/definitions"
},
"MessageTemplateContent": {
"type": "object",
"properties": {
@@ -3398,6 +3500,13 @@
},
"x-go-package": "github.com/grafana/grafana/pkg/services/ngalert/api/tooling/definitions"
},
"MessageTemplates": {
"type": "array",
"items": {
"$ref": "#/definitions/MessageTemplate"
},
"x-go-package": "github.com/grafana/grafana/pkg/services/ngalert/api/tooling/definitions"
},
"MonthRange": {
"type": "object",
"title": "A MonthRange is an inclusive range between [1, 12] where 1 = January.",
@@ -3435,6 +3544,30 @@
},
"x-go-package": "github.com/prometheus/alertmanager/config"
},
"MuteTiming": {
"type": "object",
"properties": {
"name": {
"type": "string",
"x-go-name": "Name"
},
"time_intervals": {
"type": "array",
"items": {
"$ref": "#/definitions/TimeInterval"
},
"x-go-name": "TimeIntervals"
}
},
"x-go-package": "github.com/grafana/grafana/pkg/services/ngalert/api/tooling/definitions"
},
"MuteTimings": {
"type": "array",
"items": {
"$ref": "#/definitions/MuteTiming"
},
"x-go-package": "github.com/grafana/grafana/pkg/services/ngalert/api/tooling/definitions"
},
"NamespaceConfigResponse": {
"type": "object",
"additionalProperties": {
@@ -3445,6 +3578,10 @@
},
"x-go-package": "github.com/grafana/grafana/pkg/services/ngalert/api/tooling/definitions"
},
"NotFound": {
"type": "object",
"x-go-package": "github.com/grafana/grafana/pkg/services/ngalert/api/tooling/definitions"
},
"NotifierConfig": {
"type": "object",
"title": "NotifierConfig contains base options common across all notifier configurations.",
@@ -5139,6 +5276,7 @@
"x-go-package": "github.com/prometheus/alertmanager/api/v2/models"
},
"alertGroup": {
"description": "AlertGroup alert group",
"type": "object",
"required": [
"alerts",
@@ -5161,8 +5299,6 @@
"$ref": "#/definitions/receiver"
}
},
"x-go-name": "AlertGroup",
"x-go-package": "github.com/prometheus/alertmanager/api/v2/models",
"$ref": "#/definitions/alertGroup"
},
"alertGroups": {
@@ -5553,7 +5689,6 @@
"x-go-package": "github.com/prometheus/alertmanager/api/v2/models"
},
"postableSilence": {
"description": "PostableSilence postable silence",
"type": "object",
"required": [
"comment",
@@ -5594,6 +5729,8 @@
"x-go-name": "StartsAt"
}
},
"x-go-name": "PostableSilence",
"x-go-package": "github.com/prometheus/alertmanager/api/v2/models",
"$ref": "#/definitions/postableSilence"
},
"receiver": {