mirror of
https://github.com/prometheus/alertmanager
synced 2025-01-09 07:19:42 +00:00
f1b920bcc9
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>
59 lines
1.6 KiB
Go
59 lines
1.6 KiB
Go
// Code generated by go-swagger; DO NOT EDIT.
|
|
|
|
package silence
|
|
|
|
// This file was generated by the swagger tool.
|
|
// Editing this file might prove futile when you re-run the generate command
|
|
|
|
import (
|
|
"net/http"
|
|
|
|
middleware "github.com/go-openapi/runtime/middleware"
|
|
)
|
|
|
|
// GetSilenceHandlerFunc turns a function with the right signature into a get silence handler
|
|
type GetSilenceHandlerFunc func(GetSilenceParams) middleware.Responder
|
|
|
|
// Handle executing the request and returning a response
|
|
func (fn GetSilenceHandlerFunc) Handle(params GetSilenceParams) middleware.Responder {
|
|
return fn(params)
|
|
}
|
|
|
|
// GetSilenceHandler interface for that can handle valid get silence params
|
|
type GetSilenceHandler interface {
|
|
Handle(GetSilenceParams) middleware.Responder
|
|
}
|
|
|
|
// NewGetSilence creates a new http.Handler for the get silence operation
|
|
func NewGetSilence(ctx *middleware.Context, handler GetSilenceHandler) *GetSilence {
|
|
return &GetSilence{Context: ctx, Handler: handler}
|
|
}
|
|
|
|
/*GetSilence swagger:route GET /silence/{silenceID} silence getSilence
|
|
|
|
Get a silence by its ID
|
|
|
|
*/
|
|
type GetSilence struct {
|
|
Context *middleware.Context
|
|
Handler GetSilenceHandler
|
|
}
|
|
|
|
func (o *GetSilence) ServeHTTP(rw http.ResponseWriter, r *http.Request) {
|
|
route, rCtx, _ := o.Context.RouteInfo(r)
|
|
if rCtx != nil {
|
|
r = rCtx
|
|
}
|
|
var Params = NewGetSilenceParams()
|
|
|
|
if err := o.Context.BindValidRequest(r, route, &Params); err != nil { // bind params
|
|
o.Context.Respond(rw, r, route.Produces, route, err)
|
|
return
|
|
}
|
|
|
|
res := o.Handler.Handle(Params) // actually handle the request
|
|
|
|
o.Context.Respond(rw, r, route.Produces, route, res)
|
|
|
|
}
|