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 alert
|
|
|
|
|
|
|
|
// This file was generated by the swagger tool.
|
|
|
|
// Editing this file might prove futile when you re-run the swagger generate command
|
|
|
|
|
|
|
|
import (
|
|
|
|
"net/http"
|
|
|
|
|
|
|
|
"github.com/go-openapi/errors"
|
|
|
|
"github.com/go-openapi/runtime"
|
|
|
|
"github.com/go-openapi/runtime/middleware"
|
|
|
|
"github.com/go-openapi/swag"
|
|
|
|
|
|
|
|
strfmt "github.com/go-openapi/strfmt"
|
|
|
|
)
|
|
|
|
|
|
|
|
// NewGetAlertsParams creates a new GetAlertsParams object
|
|
|
|
// with the default values initialized.
|
|
|
|
func NewGetAlertsParams() GetAlertsParams {
|
|
|
|
|
|
|
|
var (
|
|
|
|
// initialize parameters with default values
|
|
|
|
|
|
|
|
activeDefault = bool(true)
|
|
|
|
|
|
|
|
inhibitedDefault = bool(true)
|
|
|
|
|
|
|
|
silencedDefault = bool(true)
|
|
|
|
unprocessedDefault = bool(true)
|
|
|
|
)
|
|
|
|
|
|
|
|
return GetAlertsParams{
|
|
|
|
Active: &activeDefault,
|
|
|
|
|
|
|
|
Inhibited: &inhibitedDefault,
|
|
|
|
|
|
|
|
Silenced: &silencedDefault,
|
|
|
|
|
|
|
|
Unprocessed: &unprocessedDefault,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// GetAlertsParams contains all the bound params for the get alerts operation
|
|
|
|
// typically these are obtained from a http.Request
|
|
|
|
//
|
|
|
|
// swagger:parameters getAlerts
|
|
|
|
type GetAlertsParams struct {
|
|
|
|
|
|
|
|
// HTTP Request Object
|
|
|
|
HTTPRequest *http.Request `json:"-"`
|
|
|
|
|
|
|
|
/*Show active alerts
|
|
|
|
In: query
|
|
|
|
Default: true
|
|
|
|
*/
|
|
|
|
Active *bool
|
|
|
|
/*A list of matchers to filter alerts by
|
|
|
|
In: query
|
2019-03-08 08:24:46 +00:00
|
|
|
Collection Format: multi
|
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
|
|
|
*/
|
|
|
|
Filter []string
|
|
|
|
/*Show inhibited alerts
|
|
|
|
In: query
|
|
|
|
Default: true
|
|
|
|
*/
|
|
|
|
Inhibited *bool
|
|
|
|
/*A regex matching receivers to filter alerts by
|
|
|
|
In: query
|
|
|
|
*/
|
|
|
|
Receiver *string
|
|
|
|
/*Show silenced alerts
|
|
|
|
In: query
|
|
|
|
Default: true
|
|
|
|
*/
|
|
|
|
Silenced *bool
|
|
|
|
/*Show unprocessed alerts
|
|
|
|
In: query
|
|
|
|
Default: true
|
|
|
|
*/
|
|
|
|
Unprocessed *bool
|
|
|
|
}
|
|
|
|
|
|
|
|
// BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface
|
|
|
|
// for simple values it will use straight method calls.
|
|
|
|
//
|
|
|
|
// To ensure default values, the struct must have been initialized with NewGetAlertsParams() beforehand.
|
|
|
|
func (o *GetAlertsParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error {
|
|
|
|
var res []error
|
|
|
|
|
|
|
|
o.HTTPRequest = r
|
|
|
|
|
|
|
|
qs := runtime.Values(r.URL.Query())
|
|
|
|
|
|
|
|
qActive, qhkActive, _ := qs.GetOK("active")
|
|
|
|
if err := o.bindActive(qActive, qhkActive, route.Formats); err != nil {
|
|
|
|
res = append(res, err)
|
|
|
|
}
|
|
|
|
|
|
|
|
qFilter, qhkFilter, _ := qs.GetOK("filter")
|
|
|
|
if err := o.bindFilter(qFilter, qhkFilter, route.Formats); err != nil {
|
|
|
|
res = append(res, err)
|
|
|
|
}
|
|
|
|
|
|
|
|
qInhibited, qhkInhibited, _ := qs.GetOK("inhibited")
|
|
|
|
if err := o.bindInhibited(qInhibited, qhkInhibited, route.Formats); err != nil {
|
|
|
|
res = append(res, err)
|
|
|
|
}
|
|
|
|
|
|
|
|
qReceiver, qhkReceiver, _ := qs.GetOK("receiver")
|
|
|
|
if err := o.bindReceiver(qReceiver, qhkReceiver, route.Formats); err != nil {
|
|
|
|
res = append(res, err)
|
|
|
|
}
|
|
|
|
|
|
|
|
qSilenced, qhkSilenced, _ := qs.GetOK("silenced")
|
|
|
|
if err := o.bindSilenced(qSilenced, qhkSilenced, route.Formats); err != nil {
|
|
|
|
res = append(res, err)
|
|
|
|
}
|
|
|
|
|
|
|
|
qUnprocessed, qhkUnprocessed, _ := qs.GetOK("unprocessed")
|
|
|
|
if err := o.bindUnprocessed(qUnprocessed, qhkUnprocessed, route.Formats); err != nil {
|
|
|
|
res = append(res, err)
|
|
|
|
}
|
|
|
|
|
|
|
|
if len(res) > 0 {
|
|
|
|
return errors.CompositeValidationError(res...)
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// bindActive binds and validates parameter Active from query.
|
|
|
|
func (o *GetAlertsParams) bindActive(rawData []string, hasKey bool, formats strfmt.Registry) error {
|
|
|
|
var raw string
|
|
|
|
if len(rawData) > 0 {
|
|
|
|
raw = rawData[len(rawData)-1]
|
|
|
|
}
|
|
|
|
|
|
|
|
// Required: false
|
|
|
|
// AllowEmptyValue: false
|
|
|
|
if raw == "" { // empty values pass all other validations
|
|
|
|
// Default values have been previously initialized by NewGetAlertsParams()
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
value, err := swag.ConvertBool(raw)
|
|
|
|
if err != nil {
|
|
|
|
return errors.InvalidType("active", "query", "bool", raw)
|
|
|
|
}
|
|
|
|
o.Active = &value
|
|
|
|
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// bindFilter binds and validates array parameter Filter from query.
|
|
|
|
//
|
2019-03-08 08:24:46 +00:00
|
|
|
// Arrays are parsed according to CollectionFormat: "multi" (defaults to "csv" when empty).
|
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
|
|
|
func (o *GetAlertsParams) bindFilter(rawData []string, hasKey bool, formats strfmt.Registry) error {
|
|
|
|
|
2019-03-08 08:24:46 +00:00
|
|
|
// CollectionFormat: multi
|
|
|
|
filterIC := rawData
|
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
|
|
|
|
|
|
|
if len(filterIC) == 0 {
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
var filterIR []string
|
|
|
|
for _, filterIV := range filterIC {
|
|
|
|
filterI := filterIV
|
|
|
|
|
|
|
|
filterIR = append(filterIR, filterI)
|
|
|
|
}
|
|
|
|
|
|
|
|
o.Filter = filterIR
|
|
|
|
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// bindInhibited binds and validates parameter Inhibited from query.
|
|
|
|
func (o *GetAlertsParams) bindInhibited(rawData []string, hasKey bool, formats strfmt.Registry) error {
|
|
|
|
var raw string
|
|
|
|
if len(rawData) > 0 {
|
|
|
|
raw = rawData[len(rawData)-1]
|
|
|
|
}
|
|
|
|
|
|
|
|
// Required: false
|
|
|
|
// AllowEmptyValue: false
|
|
|
|
if raw == "" { // empty values pass all other validations
|
|
|
|
// Default values have been previously initialized by NewGetAlertsParams()
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
value, err := swag.ConvertBool(raw)
|
|
|
|
if err != nil {
|
|
|
|
return errors.InvalidType("inhibited", "query", "bool", raw)
|
|
|
|
}
|
|
|
|
o.Inhibited = &value
|
|
|
|
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// bindReceiver binds and validates parameter Receiver from query.
|
|
|
|
func (o *GetAlertsParams) bindReceiver(rawData []string, hasKey bool, formats strfmt.Registry) error {
|
|
|
|
var raw string
|
|
|
|
if len(rawData) > 0 {
|
|
|
|
raw = rawData[len(rawData)-1]
|
|
|
|
}
|
|
|
|
|
|
|
|
// Required: false
|
|
|
|
// AllowEmptyValue: false
|
|
|
|
if raw == "" { // empty values pass all other validations
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
o.Receiver = &raw
|
|
|
|
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// bindSilenced binds and validates parameter Silenced from query.
|
|
|
|
func (o *GetAlertsParams) bindSilenced(rawData []string, hasKey bool, formats strfmt.Registry) error {
|
|
|
|
var raw string
|
|
|
|
if len(rawData) > 0 {
|
|
|
|
raw = rawData[len(rawData)-1]
|
|
|
|
}
|
|
|
|
|
|
|
|
// Required: false
|
|
|
|
// AllowEmptyValue: false
|
|
|
|
if raw == "" { // empty values pass all other validations
|
|
|
|
// Default values have been previously initialized by NewGetAlertsParams()
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
value, err := swag.ConvertBool(raw)
|
|
|
|
if err != nil {
|
|
|
|
return errors.InvalidType("silenced", "query", "bool", raw)
|
|
|
|
}
|
|
|
|
o.Silenced = &value
|
|
|
|
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// bindUnprocessed binds and validates parameter Unprocessed from query.
|
|
|
|
func (o *GetAlertsParams) bindUnprocessed(rawData []string, hasKey bool, formats strfmt.Registry) error {
|
|
|
|
var raw string
|
|
|
|
if len(rawData) > 0 {
|
|
|
|
raw = rawData[len(rawData)-1]
|
|
|
|
}
|
|
|
|
|
|
|
|
// Required: false
|
|
|
|
// AllowEmptyValue: false
|
|
|
|
if raw == "" { // empty values pass all other validations
|
|
|
|
// Default values have been previously initialized by NewGetAlertsParams()
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
value, err := swag.ConvertBool(raw)
|
|
|
|
if err != nil {
|
|
|
|
return errors.InvalidType("unprocessed", "query", "bool", raw)
|
|
|
|
}
|
|
|
|
o.Unprocessed = &value
|
|
|
|
|
|
|
|
return nil
|
|
|
|
}
|