From f977e3faf578ec15c3b65f624dbd689e36145f5d Mon Sep 17 00:00:00 2001 From: Julien Duchesne Date: Tue, 12 Dec 2023 13:40:36 -0500 Subject: [PATCH] ngalert swagger: Fix status code (#79415) This endpoint returns a 202, not a 204 Let me know if we should instead change the response of the API --- pkg/services/ngalert/api/tooling/api.json | 15 ++++++++------- .../definitions/provisioning_contactpoints.go | 2 +- pkg/services/ngalert/api/tooling/post.json | 12 +++++------- pkg/services/ngalert/api/tooling/spec.json | 12 +++++------- public/api-merged.json | 15 ++++++++------- public/openapi3.json | 15 ++++++++------- 6 files changed, 35 insertions(+), 36 deletions(-) diff --git a/pkg/services/ngalert/api/tooling/api.json b/pkg/services/ngalert/api/tooling/api.json index da46e288d21..b6f6055fc1e 100644 --- a/pkg/services/ngalert/api/tooling/api.json +++ b/pkg/services/ngalert/api/tooling/api.json @@ -1928,13 +1928,13 @@ }, "MuteTimeIntervalExport": { "properties": { - "OrgID": { - "format": "int64", - "type": "integer" - }, "name": { "type": "string" }, + "orgId": { + "format": "int64", + "type": "integer" + }, "time_intervals": { "items": { "$ref": "#/definitions/TimeInterval" @@ -4252,6 +4252,7 @@ "type": "object" }, "alertGroups": { + "description": "AlertGroups alert groups", "items": { "$ref": "#/definitions/alertGroup" }, @@ -4356,6 +4357,7 @@ "type": "object" }, "gettableAlert": { + "description": "GettableAlert gettable alert", "properties": { "annotations": { "$ref": "#/definitions/labelSet" @@ -4418,7 +4420,6 @@ "type": "array" }, "gettableSilence": { - "description": "GettableSilence gettable silence", "properties": { "comment": { "description": "comment", @@ -4467,7 +4468,6 @@ "type": "object" }, "gettableSilences": { - "description": "GettableSilences gettable silences", "items": { "$ref": "#/definitions/gettableSilence" }, @@ -4618,6 +4618,7 @@ "type": "array" }, "postableSilence": { + "description": "PostableSilence postable silence", "properties": { "comment": { "description": "comment", @@ -5156,7 +5157,7 @@ } ], "responses": { - "204": { + "202": { "description": " The contact point was deleted successfully." } }, diff --git a/pkg/services/ngalert/api/tooling/definitions/provisioning_contactpoints.go b/pkg/services/ngalert/api/tooling/definitions/provisioning_contactpoints.go index 6f9d02354e3..2cad1b0f00b 100644 --- a/pkg/services/ngalert/api/tooling/definitions/provisioning_contactpoints.go +++ b/pkg/services/ngalert/api/tooling/definitions/provisioning_contactpoints.go @@ -49,7 +49,7 @@ import ( // - application/json // // Responses: -// 204: description: The contact point was deleted successfully. +// 202: description: The contact point was deleted successfully. // swagger:parameters RoutePutContactpoint RouteDeleteContactpoints type ContactPointUIDReference struct { diff --git a/pkg/services/ngalert/api/tooling/post.json b/pkg/services/ngalert/api/tooling/post.json index 8ae6df6a8f5..e69fb825d72 100644 --- a/pkg/services/ngalert/api/tooling/post.json +++ b/pkg/services/ngalert/api/tooling/post.json @@ -1928,13 +1928,13 @@ }, "MuteTimeIntervalExport": { "properties": { - "OrgID": { - "format": "int64", - "type": "integer" - }, "name": { "type": "string" }, + "orgId": { + "format": "int64", + "type": "integer" + }, "time_intervals": { "items": { "$ref": "#/definitions/TimeInterval" @@ -4419,7 +4419,6 @@ "type": "array" }, "gettableSilence": { - "description": "GettableSilence gettable silence", "properties": { "comment": { "description": "comment", @@ -4618,7 +4617,6 @@ "type": "array" }, "postableSilence": { - "description": "PostableSilence postable silence", "properties": { "comment": { "description": "comment", @@ -7136,7 +7134,7 @@ } ], "responses": { - "204": { + "202": { "description": " The contact point was deleted successfully." } }, diff --git a/pkg/services/ngalert/api/tooling/spec.json b/pkg/services/ngalert/api/tooling/spec.json index 05195a1a1c5..42dc2c56271 100644 --- a/pkg/services/ngalert/api/tooling/spec.json +++ b/pkg/services/ngalert/api/tooling/spec.json @@ -2433,7 +2433,7 @@ } ], "responses": { - "204": { + "202": { "description": " The contact point was deleted successfully." } } @@ -5082,13 +5082,13 @@ "MuteTimeIntervalExport": { "type": "object", "properties": { - "OrgID": { - "type": "integer", - "format": "int64" - }, "name": { "type": "string" }, + "orgId": { + "type": "integer", + "format": "int64" + }, "time_intervals": { "type": "array", "items": { @@ -7576,7 +7576,6 @@ "$ref": "#/definitions/gettableAlerts" }, "gettableSilence": { - "description": "GettableSilence gettable silence", "type": "object", "required": [ "comment", @@ -7778,7 +7777,6 @@ } }, "postableSilence": { - "description": "PostableSilence postable silence", "type": "object", "required": [ "comment", diff --git a/public/api-merged.json b/public/api-merged.json index eb69b1bf81c..f10021f65a6 100644 --- a/public/api-merged.json +++ b/public/api-merged.json @@ -2891,7 +2891,7 @@ } ], "responses": { - "204": { + "202": { "description": " The contact point was deleted successfully." } } @@ -15785,13 +15785,13 @@ "MuteTimeIntervalExport": { "type": "object", "properties": { - "OrgID": { - "type": "integer", - "format": "int64" - }, "name": { "type": "string" }, + "orgId": { + "type": "integer", + "format": "int64" + }, "time_intervals": { "type": "array", "items": { @@ -20671,6 +20671,7 @@ } }, "alertGroups": { + "description": "AlertGroups alert groups", "type": "array", "items": { "$ref": "#/definitions/alertGroup" @@ -20803,6 +20804,7 @@ } }, "gettableAlert": { + "description": "GettableAlert gettable alert", "type": "object", "required": [ "labels", @@ -20865,7 +20867,6 @@ } }, "gettableSilence": { - "description": "GettableSilence gettable silence", "type": "object", "required": [ "comment", @@ -20914,7 +20915,6 @@ } }, "gettableSilences": { - "description": "GettableSilences gettable silences", "type": "array", "items": { "$ref": "#/definitions/gettableSilence" @@ -21065,6 +21065,7 @@ } }, "postableSilence": { + "description": "PostableSilence postable silence", "type": "object", "required": [ "comment", diff --git a/public/openapi3.json b/public/openapi3.json index e76cefac691..e334c8a4e87 100644 --- a/public/openapi3.json +++ b/public/openapi3.json @@ -6717,13 +6717,13 @@ }, "MuteTimeIntervalExport": { "properties": { - "OrgID": { - "format": "int64", - "type": "integer" - }, "name": { "type": "string" }, + "orgId": { + "format": "int64", + "type": "integer" + }, "time_intervals": { "items": { "$ref": "#/components/schemas/TimeInterval" @@ -11602,6 +11602,7 @@ "type": "object" }, "alertGroups": { + "description": "AlertGroups alert groups", "items": { "$ref": "#/components/schemas/alertGroup" }, @@ -11734,6 +11735,7 @@ "type": "object" }, "gettableAlert": { + "description": "GettableAlert gettable alert", "properties": { "annotations": { "$ref": "#/components/schemas/labelSet" @@ -11796,7 +11798,6 @@ "type": "array" }, "gettableSilence": { - "description": "GettableSilence gettable silence", "properties": { "comment": { "description": "comment", @@ -11845,7 +11846,6 @@ "type": "object" }, "gettableSilences": { - "description": "GettableSilences gettable silences", "items": { "$ref": "#/components/schemas/gettableSilence" }, @@ -11996,6 +11996,7 @@ "type": "array" }, "postableSilence": { + "description": "PostableSilence postable silence", "properties": { "comment": { "description": "comment", @@ -15294,7 +15295,7 @@ } ], "responses": { - "204": { + "202": { "description": " The contact point was deleted successfully." } },