RepoMirrors/alertmanager
1
0
Fork 0
mirror of https://github.com/prometheus/alertmanager synced 2025-01-08 23:09:36 +00:00
Code Issues Packages Projects Releases Wiki Activity
f1b920bcc9
alertmanager/api/v2/restapi/embedded_spec.go

1053 lines
24 KiB
Go
Raw Normal View History

api: Implement OpenAPI generated Alertmanager API V2 The current Alertmanager API v1 is undocumented and written by hand. This patch introduces a new Alertmanager API - v2. The API is fully generated via an OpenAPI 2.0 [1] specification (see `api/v2/openapi.yaml`) with the exception of the http handlers itself. Pros: - Generated server code - Ability to generate clients in all major languages (Go, Java, JS, Python, Ruby, Haskell, *elm* [3] ...) - Strict contract (OpenAPI spec) between server and clients. - Instant feedback on frontend-breaking changes, due to strictly typed frontend language elm. - Generated documentation (See Alertmanager online Swagger UI [4]) Cons: - Dependency on open api ecosystem including go-swagger [2] In addition this patch includes the following changes. - README.md: Add API section - test: Duplicate acceptance test to API v1 & API v2 version The Alertmanager acceptance test framework has a decent test coverage on the Alertmanager API. Introducing the Alertmanager API v2 does not go hand in hand with deprecating API v1. They should live alongside each other for a couple of minor Alertmanager versions. Instead of porting the acceptance test framework to use the new API v2, this patch duplicates the acceptance tests, one using the API v1, the other API v2. Once API v1 is removed we can simply remove `test/with_api_v1` and bring `test/with_api_v2` to `test/`. [1] https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md [2] https://github.com/go-swagger/go-swagger/ [3] https://github.com/ahultgren/swagger-elm [4] http://petstore.swagger.io/?url=https://raw.githubusercontent.com/mxinden/alertmanager/apiv2/api/v2/openapi.yaml Signed-off-by: Max Leonard Inden <IndenML@gmail.com>
2018-04-26 06:12:49 +00:00
// Code generated by go-swagger; DO NOT EDIT.
package restapi
// This file was generated by the swagger tool.
// Editing this file might prove futile when you re-run the swagger generate command
import (
"encoding/json"
)
var (
// SwaggerJSON embedded version of the swagger document used at generation time
SwaggerJSON json.RawMessage
// FlatSwaggerJSON embedded flattened version of the swagger document used at generation time
FlatSwaggerJSON json.RawMessage
)
func init() {
SwaggerJSON = json.RawMessage([]byte(`{
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"swagger": "2.0",
"info": {
"description": "API of the Prometheus Alertmanager (https://github.com/prometheus/alertmanager)",
"title": "Alertmanager API",
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
},
"version": "0.0.1"
},
"paths": {
"/alerts": {
"get": {
"description": "Get a list of alerts",
"tags": [
"alert"
],
"operationId": "getAlerts",
"parameters": [
{
"type": "boolean",
"default": true,
"description": "Show active alerts",
"name": "active",
"in": "query"
},
{
"type": "boolean",
"default": true,
"description": "Show silenced alerts",
"name": "silenced",
"in": "query"
},
{
"type": "boolean",
"default": true,
"description": "Show inhibited alerts",
"name": "inhibited",
"in": "query"
},
{
"type": "boolean",
"default": true,
"description": "Show unprocessed alerts",
"name": "unprocessed",
"in": "query"
},
{
"type": "array",
"items": {
"type": "string"
},
"description": "A list of matchers to filter alerts by",
"name": "filter",
"in": "query"
},
{
"type": "string",
"description": "A regex matching receivers to filter alerts by",
"name": "receiver",
"in": "query"
}
],
"responses": {
"200": {
"description": "Get alerts response",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/alert"
}
}
},
"400": {
"$ref": "#/responses/BadRequest"
},
"500": {
"$ref": "#/responses/InternalServerError"
}
}
},
"post": {
"description": "Create new Alerts",
"tags": [
"alert"
],
"operationId": "postAlerts",
"parameters": [
{
"description": "The alerts to create",
"name": "alerts",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/alerts"
}
}
],
"responses": {
"200": {
"description": "Create alerts response"
},
"400": {
"$ref": "#/responses/BadRequest"
},
"500": {
"$ref": "#/responses/InternalServerError"
}
}
}
},
"/receivers": {
"get": {
"description": "Get list of all receivers (name of notification integrations)",
"tags": [
"receiver"
],
"operationId": "getReceivers",
"responses": {
"200": {
"description": "Get receivers response",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/receiver"
}
}
}
}
}
},
"/silence/{silenceID}": {
"get": {
"description": "Get a silence by its ID",
"tags": [
"silence"
],
"operationId": "getSilence",
"responses": {
"200": {
"description": "Get silence response",
"schema": {
"$ref": "#/definitions/silence"
}
},
"404": {
"description": "A silence with the specified ID was not found"
},
"500": {
"$ref": "#/responses/InternalServerError"
}
}
},
"delete": {
"description": "Delete a silence by its ID",
"tags": [
"silence"
],
"operationId": "deleteSilence",
"parameters": [
{
"type": "string",
"format": "uuid",
"description": "ID of the silence to get",
"name": "silenceID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Delete silence response"
},
"500": {
"$ref": "#/responses/InternalServerError"
}
}
},
"parameters": [
{
"type": "string",
"format": "uuid",
"description": "ID of the silence to get",
"name": "silenceID",
"in": "path",
"required": true
}
]
},
"/silences": {
"get": {
"description": "Get a list of silences",
"tags": [
"silence"
],
"operationId": "getSilences",
"parameters": [
{
"type": "array",
"items": {
"type": "string"
},
"description": "A list of matchers to filter silences by",
"name": "filter",
"in": "query"
}
],
"responses": {
"200": {
"description": "Get silences response",
"schema": {
"$ref": "#/definitions/silences"
}
},
"500": {
"$ref": "#/responses/InternalServerError"
}
}
},
"post": {
"description": "Post a new silence or update an existing one",
"tags": [
"silence"
],
"operationId": "postSilences",
"parameters": [
{
"description": "The silence to create",
"name": "silence",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/silence"
}
}
],
"responses": {
"200": {
"description": "Create / update silence response",
"schema": {
"type": "object",
"properties": {
"silenceID": {
"type": "string"
}
}
}
},
"400": {
"$ref": "#/responses/BadRequest"
}
}
}
},
"/status": {
"get": {
"description": "Get current status of an Alertmanager instance and its cluster",
"tags": [
"general"
],
"operationId": "getStatus",
"responses": {
"200": {
"description": "Get status response",
"schema": {
"$ref": "#/definitions/alertmanagerStatus"
}
}
}
}
}
},
"definitions": {
"alert": {
"type": "object",
"properties": {
"annotations": {
"$ref": "#/definitions/labelSet"
},
"endsAt": {
"type": "string",
"format": "date-time"
},
"fingerprint": {
"type": "string"
},
"generatorURL": {
"type": "string",
"format": "uri"
},
"labels": {
"$ref": "#/definitions/labelSet"
},
"receivers": {
"type": "array",
"items": {
"$ref": "#/definitions/receiver"
}
},
"startsAt": {
"type": "string",
"format": "date-time"
},
"status": {
"type": "object",
"properties": {
"inhibitedBy": {
"type": "array",
"items": {
"type": "string"
}
},
"silencedBy": {
"type": "array",
"items": {
"type": "string"
}
},
"state": {
"type": "string",
"enum": [
"unprocessed",
"active",
"suppressed"
]
}
}
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
}
},
"alertmanagerStatus": {
"type": "object",
"required": [
"name",
"statusInCluster",
"peers"
],
"properties": {
"name": {
"type": "string"
},
"peers": {
"type": "array",
"minimum": 0,
"items": {
"$ref": "#/definitions/peerStatus"
}
},
"statusInCluster": {
"type": "string"
}
}
},
"alerts": {
"type": "array",
"items": {
"$ref": "#/definitions/alert"
}
},
"labelSet": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"matcher": {
"type": "object",
"properties": {
"isRegex": {
"type": "boolean"
},
"name": {
"type": "string"
},
"regex": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"matchers": {
"type": "array",
"minItems": 1,
"items": {
"$ref": "#/definitions/matcher"
}
},
"peerStatus": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"receiver": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
},
"silence": {
"type": "object",
"required": [
"matchers"
],
"properties": {
"comment": {
"type": "string"
},
"createdBy": {
"type": "string"
},
"endsAt": {
"type": "string",
"format": "date-time"
},
"id": {
"type": "string"
},
"matchers": {
"$ref": "#/definitions/matchers"
},
"startsAt": {
"type": "string",
"format": "date-time"
},
"status": {
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": [
"expired",
"active",
"pending"
]
}
}
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
}
},
"silences": {
"type": "array",
"items": {
"$ref": "#/definitions/silence"
}
}
},
"responses": {
"BadRequest": {
"description": "Bad request",
"schema": {
"type": "string"
}
},
"InternalServerError": {
"description": "Internal server error",
"schema": {
"type": "string"
}
}
},
"tags": [
{
"description": "General Alertmanager operations",
"name": "general"
},
{
"description": "Everything related to Alertmanager receivers",
"name": "receiver"
},
{
"description": "Everything related to Alertmanager silences",
"name": "silence"
},
{
"description": "Everything related to Alertmanager alerts",
"name": "alert"
}
]
}`))
FlatSwaggerJSON = json.RawMessage([]byte(`{
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"swagger": "2.0",
"info": {
"description": "API of the Prometheus Alertmanager (https://github.com/prometheus/alertmanager)",
"title": "Alertmanager API",
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
},
"version": "0.0.1"
},
"paths": {
"/alerts": {
"get": {
"description": "Get a list of alerts",
"tags": [
"alert"
],
"operationId": "getAlerts",
"parameters": [
{
"type": "boolean",
"default": true,
"description": "Show active alerts",
"name": "active",
"in": "query"
},
{
"type": "boolean",
"default": true,
"description": "Show silenced alerts",
"name": "silenced",
"in": "query"
},
{
"type": "boolean",
"default": true,
"description": "Show inhibited alerts",
"name": "inhibited",
"in": "query"
},
{
"type": "boolean",
"default": true,
"description": "Show unprocessed alerts",
"name": "unprocessed",
"in": "query"
},
{
"type": "array",
"items": {
"type": "string"
},
"description": "A list of matchers to filter alerts by",
"name": "filter",
"in": "query"
},
{
"type": "string",
"description": "A regex matching receivers to filter alerts by",
"name": "receiver",
"in": "query"
}
],
"responses": {
"200": {
"description": "Get alerts response",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/alert"
}
}
},
"400": {
"description": "Bad request",
"schema": {
"type": "string"
}
},
"500": {
"description": "Internal server error",
"schema": {
"type": "string"
}
}
}
},
"post": {
"description": "Create new Alerts",
"tags": [
"alert"
],
"operationId": "postAlerts",
"parameters": [
{
"description": "The alerts to create",
"name": "alerts",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/alerts"
}
}
],
"responses": {
"200": {
"description": "Create alerts response"
},
"400": {
"description": "Bad request",
"schema": {
"type": "string"
}
},
"500": {
"description": "Internal server error",
"schema": {
"type": "string"
}
}
}
}
},
"/receivers": {
"get": {
"description": "Get list of all receivers (name of notification integrations)",
"tags": [
"receiver"
],
"operationId": "getReceivers",
"responses": {
"200": {
"description": "Get receivers response",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/receiver"
}
}
}
}
}
},
"/silence/{silenceID}": {
"get": {
"description": "Get a silence by its ID",
"tags": [
"silence"
],
"operationId": "getSilence",
"responses": {
"200": {
"description": "Get silence response",
"schema": {
"$ref": "#/definitions/silence"
}
},
"404": {
"description": "A silence with the specified ID was not found"
},
"500": {
"description": "Internal server error",
"schema": {
"type": "string"
}
}
}
},
"delete": {
"description": "Delete a silence by its ID",
"tags": [
"silence"
],
"operationId": "deleteSilence",
"parameters": [
{
"type": "string",
"format": "uuid",
"description": "ID of the silence to get",
"name": "silenceID",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Delete silence response"
},
"500": {
"description": "Internal server error",
"schema": {
"type": "string"
}
}
}
},
"parameters": [
{
"type": "string",
"format": "uuid",
"description": "ID of the silence to get",
"name": "silenceID",
"in": "path",
"required": true
}
]
},
"/silences": {
"get": {
"description": "Get a list of silences",
"tags": [
"silence"
],
"operationId": "getSilences",
"parameters": [
{
"type": "array",
"items": {
"type": "string"
},
"description": "A list of matchers to filter silences by",
"name": "filter",
"in": "query"
}
],
"responses": {
"200": {
"description": "Get silences response",
"schema": {
"$ref": "#/definitions/silences"
}
},
"500": {
"description": "Internal server error",
"schema": {
"type": "string"
}
}
}
},
"post": {
"description": "Post a new silence or update an existing one",
"tags": [
"silence"
],
"operationId": "postSilences",
"parameters": [
{
"description": "The silence to create",
"name": "silence",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/silence"
}
}
],
"responses": {
"200": {
"description": "Create / update silence response",
"schema": {
"type": "object",
"properties": {
"silenceID": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad request",
"schema": {
"type": "string"
}
}
}
}
},
"/status": {
"get": {
"description": "Get current status of an Alertmanager instance and its cluster",
"tags": [
"general"
],
"operationId": "getStatus",
"responses": {
"200": {
"description": "Get status response",
"schema": {
"$ref": "#/definitions/alertmanagerStatus"
}
}
}
}
}
},
"definitions": {
"alert": {
"type": "object",
"properties": {
"annotations": {
"$ref": "#/definitions/labelSet"
},
"endsAt": {
"type": "string",
"format": "date-time"
},
"fingerprint": {
"type": "string"
},
"generatorURL": {
"type": "string",
"format": "uri"
},
"labels": {
"$ref": "#/definitions/labelSet"
},
"receivers": {
"type": "array",
"items": {
"$ref": "#/definitions/receiver"
}
},
"startsAt": {
"type": "string",
"format": "date-time"
},
"status": {
"type": "object",
"properties": {
"inhibitedBy": {
"type": "array",
"items": {
"type": "string"
}
},
"silencedBy": {
"type": "array",
"items": {
"type": "string"
}
},
"state": {
"type": "string",
"enum": [
"unprocessed",
"active",
"suppressed"
]
}
}
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
}
},
"alertmanagerStatus": {
"type": "object",
"required": [
"name",
"statusInCluster",
"peers"
],
"properties": {
"name": {
"type": "string"
},
"peers": {
"type": "array",
"minimum": 0,
"items": {
"$ref": "#/definitions/peerStatus"
}
},
"statusInCluster": {
"type": "string"
}
}
},
"alerts": {
"type": "array",
"items": {
"$ref": "#/definitions/alert"
}
},
"labelSet": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"matcher": {
"type": "object",
"properties": {
"isRegex": {
"type": "boolean"
},
"name": {
"type": "string"
},
"regex": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"matchers": {
"type": "array",
"minItems": 1,
"items": {
"$ref": "#/definitions/matcher"
}
},
"peerStatus": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"receiver": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
},
"silence": {
"type": "object",
"required": [
"matchers"
],
"properties": {
"comment": {
"type": "string"
},
"createdBy": {
"type": "string"
},
"endsAt": {
"type": "string",
"format": "date-time"
},
"id": {
"type": "string"
},
"matchers": {
"$ref": "#/definitions/matchers"
},
"startsAt": {
"type": "string",
"format": "date-time"
},
"status": {
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": [
"expired",
"active",
"pending"
]
}
}
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
}
},
"silences": {
"type": "array",
"items": {
"$ref": "#/definitions/silence"
}
}
},
"responses": {
"BadRequest": {
"description": "Bad request",
"schema": {
"type": "string"
}
},
"InternalServerError": {
"description": "Internal server error",
"schema": {
"type": "string"
}
}
},
"tags": [
{
"description": "General Alertmanager operations",
"name": "general"
},
{
"description": "Everything related to Alertmanager receivers",
"name": "receiver"
},
{
"description": "Everything related to Alertmanager silences",
"name": "silence"
},
{
"description": "Everything related to Alertmanager alerts",
"name": "alert"
}
]
}`))
}
Reference in New Issue Copy Permalink