mirror of
https://github.com/prometheus/alertmanager
synced 2025-05-05 01:08:13 +00:00
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>
85 lines
2.2 KiB
Go
85 lines
2.2 KiB
Go
// Code generated by go-swagger; DO NOT EDIT.
|
|
|
|
package receiver
|
|
|
|
// This file was generated by the swagger tool.
|
|
// Editing this file might prove futile when you re-run the generate command
|
|
|
|
import (
|
|
"errors"
|
|
"net/url"
|
|
golangswaggerpaths "path"
|
|
)
|
|
|
|
// GetReceiversURL generates an URL for the get receivers operation
|
|
type GetReceiversURL struct {
|
|
_basePath string
|
|
}
|
|
|
|
// WithBasePath sets the base path for this url builder, only required when it's different from the
|
|
// base path specified in the swagger spec.
|
|
// When the value of the base path is an empty string
|
|
func (o *GetReceiversURL) WithBasePath(bp string) *GetReceiversURL {
|
|
o.SetBasePath(bp)
|
|
return o
|
|
}
|
|
|
|
// SetBasePath sets the base path for this url builder, only required when it's different from the
|
|
// base path specified in the swagger spec.
|
|
// When the value of the base path is an empty string
|
|
func (o *GetReceiversURL) SetBasePath(bp string) {
|
|
o._basePath = bp
|
|
}
|
|
|
|
// Build a url path and query string
|
|
func (o *GetReceiversURL) Build() (*url.URL, error) {
|
|
var result url.URL
|
|
|
|
var _path = "/receivers"
|
|
|
|
_basePath := o._basePath
|
|
result.Path = golangswaggerpaths.Join(_basePath, _path)
|
|
|
|
return &result, nil
|
|
}
|
|
|
|
// Must is a helper function to panic when the url builder returns an error
|
|
func (o *GetReceiversURL) Must(u *url.URL, err error) *url.URL {
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
if u == nil {
|
|
panic("url can't be nil")
|
|
}
|
|
return u
|
|
}
|
|
|
|
// String returns the string representation of the path with query string
|
|
func (o *GetReceiversURL) String() string {
|
|
return o.Must(o.Build()).String()
|
|
}
|
|
|
|
// BuildFull builds a full url with scheme, host, path and query string
|
|
func (o *GetReceiversURL) BuildFull(scheme, host string) (*url.URL, error) {
|
|
if scheme == "" {
|
|
return nil, errors.New("scheme is required for a full url on GetReceiversURL")
|
|
}
|
|
if host == "" {
|
|
return nil, errors.New("host is required for a full url on GetReceiversURL")
|
|
}
|
|
|
|
base, err := o.Build()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
base.Scheme = scheme
|
|
base.Host = host
|
|
return base, nil
|
|
}
|
|
|
|
// StringFull returns the string representation of a complete url
|
|
func (o *GetReceiversURL) StringFull(scheme, host string) string {
|
|
return o.Must(o.BuildFull(scheme, host)).String()
|
|
}
|