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.
|
|
|
|
|
2019-03-05 17:57:07 +00:00
|
|
|
// Copyright Prometheus Team
|
|
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
// you may not use this file except in compliance with the License.
|
|
|
|
// You may obtain a copy of the License at
|
|
|
|
//
|
|
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
//
|
|
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
// See the License for the specific language governing permissions and
|
|
|
|
// limitations under the License.
|
|
|
|
//
|
|
|
|
|
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
|
|
|
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 (
|
2019-02-26 11:18:57 +00:00
|
|
|
"context"
|
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
|
|
|
"net/http"
|
|
|
|
"time"
|
|
|
|
|
|
|
|
"github.com/go-openapi/errors"
|
|
|
|
"github.com/go-openapi/runtime"
|
|
|
|
cr "github.com/go-openapi/runtime/client"
|
2021-03-10 18:00:22 +00:00
|
|
|
"github.com/go-openapi/strfmt"
|
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
|
|
|
"github.com/go-openapi/swag"
|
|
|
|
)
|
|
|
|
|
|
|
|
// NewGetAlertsParams creates a new GetAlertsParams object
|
|
|
|
// with the default values initialized.
|
|
|
|
func NewGetAlertsParams() *GetAlertsParams {
|
|
|
|
var (
|
|
|
|
activeDefault = bool(true)
|
|
|
|
inhibitedDefault = bool(true)
|
|
|
|
silencedDefault = bool(true)
|
|
|
|
unprocessedDefault = bool(true)
|
|
|
|
)
|
|
|
|
return &GetAlertsParams{
|
|
|
|
Active: &activeDefault,
|
|
|
|
Inhibited: &inhibitedDefault,
|
|
|
|
Silenced: &silencedDefault,
|
|
|
|
Unprocessed: &unprocessedDefault,
|
|
|
|
|
|
|
|
timeout: cr.DefaultTimeout,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// NewGetAlertsParamsWithTimeout creates a new GetAlertsParams object
|
|
|
|
// with the default values initialized, and the ability to set a timeout on a request
|
|
|
|
func NewGetAlertsParamsWithTimeout(timeout time.Duration) *GetAlertsParams {
|
|
|
|
var (
|
|
|
|
activeDefault = bool(true)
|
|
|
|
inhibitedDefault = bool(true)
|
|
|
|
silencedDefault = bool(true)
|
|
|
|
unprocessedDefault = bool(true)
|
|
|
|
)
|
|
|
|
return &GetAlertsParams{
|
|
|
|
Active: &activeDefault,
|
|
|
|
Inhibited: &inhibitedDefault,
|
|
|
|
Silenced: &silencedDefault,
|
|
|
|
Unprocessed: &unprocessedDefault,
|
|
|
|
|
|
|
|
timeout: timeout,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// NewGetAlertsParamsWithContext creates a new GetAlertsParams object
|
|
|
|
// with the default values initialized, and the ability to set a context for a request
|
|
|
|
func NewGetAlertsParamsWithContext(ctx context.Context) *GetAlertsParams {
|
|
|
|
var (
|
|
|
|
activeDefault = bool(true)
|
|
|
|
inhibitedDefault = bool(true)
|
|
|
|
silencedDefault = bool(true)
|
|
|
|
unprocessedDefault = bool(true)
|
|
|
|
)
|
|
|
|
return &GetAlertsParams{
|
|
|
|
Active: &activeDefault,
|
|
|
|
Inhibited: &inhibitedDefault,
|
|
|
|
Silenced: &silencedDefault,
|
|
|
|
Unprocessed: &unprocessedDefault,
|
|
|
|
|
|
|
|
Context: ctx,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// NewGetAlertsParamsWithHTTPClient creates a new GetAlertsParams object
|
|
|
|
// with the default values initialized, and the ability to set a custom HTTPClient for a request
|
|
|
|
func NewGetAlertsParamsWithHTTPClient(client *http.Client) *GetAlertsParams {
|
|
|
|
var (
|
|
|
|
activeDefault = bool(true)
|
|
|
|
inhibitedDefault = bool(true)
|
|
|
|
silencedDefault = bool(true)
|
|
|
|
unprocessedDefault = bool(true)
|
|
|
|
)
|
|
|
|
return &GetAlertsParams{
|
|
|
|
Active: &activeDefault,
|
|
|
|
Inhibited: &inhibitedDefault,
|
|
|
|
Silenced: &silencedDefault,
|
|
|
|
Unprocessed: &unprocessedDefault,
|
|
|
|
HTTPClient: client,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/*GetAlertsParams contains all the parameters to send to the API endpoint
|
|
|
|
for the get alerts operation typically these are written to a http.Request
|
|
|
|
*/
|
|
|
|
type GetAlertsParams struct {
|
|
|
|
|
|
|
|
/*Active
|
|
|
|
Show active alerts
|
|
|
|
|
|
|
|
*/
|
|
|
|
Active *bool
|
|
|
|
/*Filter
|
|
|
|
A list of matchers to filter alerts by
|
|
|
|
|
|
|
|
*/
|
|
|
|
Filter []string
|
|
|
|
/*Inhibited
|
|
|
|
Show inhibited alerts
|
|
|
|
|
|
|
|
*/
|
|
|
|
Inhibited *bool
|
|
|
|
/*Receiver
|
|
|
|
A regex matching receivers to filter alerts by
|
|
|
|
|
|
|
|
*/
|
|
|
|
Receiver *string
|
|
|
|
/*Silenced
|
|
|
|
Show silenced alerts
|
|
|
|
|
|
|
|
*/
|
|
|
|
Silenced *bool
|
|
|
|
/*Unprocessed
|
|
|
|
Show unprocessed alerts
|
|
|
|
|
|
|
|
*/
|
|
|
|
Unprocessed *bool
|
|
|
|
|
|
|
|
timeout time.Duration
|
|
|
|
Context context.Context
|
|
|
|
HTTPClient *http.Client
|
|
|
|
}
|
|
|
|
|
|
|
|
// WithTimeout adds the timeout to the get alerts params
|
|
|
|
func (o *GetAlertsParams) WithTimeout(timeout time.Duration) *GetAlertsParams {
|
|
|
|
o.SetTimeout(timeout)
|
|
|
|
return o
|
|
|
|
}
|
|
|
|
|
|
|
|
// SetTimeout adds the timeout to the get alerts params
|
|
|
|
func (o *GetAlertsParams) SetTimeout(timeout time.Duration) {
|
|
|
|
o.timeout = timeout
|
|
|
|
}
|
|
|
|
|
|
|
|
// WithContext adds the context to the get alerts params
|
|
|
|
func (o *GetAlertsParams) WithContext(ctx context.Context) *GetAlertsParams {
|
|
|
|
o.SetContext(ctx)
|
|
|
|
return o
|
|
|
|
}
|
|
|
|
|
|
|
|
// SetContext adds the context to the get alerts params
|
|
|
|
func (o *GetAlertsParams) SetContext(ctx context.Context) {
|
|
|
|
o.Context = ctx
|
|
|
|
}
|
|
|
|
|
|
|
|
// WithHTTPClient adds the HTTPClient to the get alerts params
|
|
|
|
func (o *GetAlertsParams) WithHTTPClient(client *http.Client) *GetAlertsParams {
|
|
|
|
o.SetHTTPClient(client)
|
|
|
|
return o
|
|
|
|
}
|
|
|
|
|
|
|
|
// SetHTTPClient adds the HTTPClient to the get alerts params
|
|
|
|
func (o *GetAlertsParams) SetHTTPClient(client *http.Client) {
|
|
|
|
o.HTTPClient = client
|
|
|
|
}
|
|
|
|
|
|
|
|
// WithActive adds the active to the get alerts params
|
|
|
|
func (o *GetAlertsParams) WithActive(active *bool) *GetAlertsParams {
|
|
|
|
o.SetActive(active)
|
|
|
|
return o
|
|
|
|
}
|
|
|
|
|
|
|
|
// SetActive adds the active to the get alerts params
|
|
|
|
func (o *GetAlertsParams) SetActive(active *bool) {
|
|
|
|
o.Active = active
|
|
|
|
}
|
|
|
|
|
|
|
|
// WithFilter adds the filter to the get alerts params
|
|
|
|
func (o *GetAlertsParams) WithFilter(filter []string) *GetAlertsParams {
|
|
|
|
o.SetFilter(filter)
|
|
|
|
return o
|
|
|
|
}
|
|
|
|
|
|
|
|
// SetFilter adds the filter to the get alerts params
|
|
|
|
func (o *GetAlertsParams) SetFilter(filter []string) {
|
|
|
|
o.Filter = filter
|
|
|
|
}
|
|
|
|
|
|
|
|
// WithInhibited adds the inhibited to the get alerts params
|
|
|
|
func (o *GetAlertsParams) WithInhibited(inhibited *bool) *GetAlertsParams {
|
|
|
|
o.SetInhibited(inhibited)
|
|
|
|
return o
|
|
|
|
}
|
|
|
|
|
|
|
|
// SetInhibited adds the inhibited to the get alerts params
|
|
|
|
func (o *GetAlertsParams) SetInhibited(inhibited *bool) {
|
|
|
|
o.Inhibited = inhibited
|
|
|
|
}
|
|
|
|
|
|
|
|
// WithReceiver adds the receiver to the get alerts params
|
|
|
|
func (o *GetAlertsParams) WithReceiver(receiver *string) *GetAlertsParams {
|
|
|
|
o.SetReceiver(receiver)
|
|
|
|
return o
|
|
|
|
}
|
|
|
|
|
|
|
|
// SetReceiver adds the receiver to the get alerts params
|
|
|
|
func (o *GetAlertsParams) SetReceiver(receiver *string) {
|
|
|
|
o.Receiver = receiver
|
|
|
|
}
|
|
|
|
|
|
|
|
// WithSilenced adds the silenced to the get alerts params
|
|
|
|
func (o *GetAlertsParams) WithSilenced(silenced *bool) *GetAlertsParams {
|
|
|
|
o.SetSilenced(silenced)
|
|
|
|
return o
|
|
|
|
}
|
|
|
|
|
|
|
|
// SetSilenced adds the silenced to the get alerts params
|
|
|
|
func (o *GetAlertsParams) SetSilenced(silenced *bool) {
|
|
|
|
o.Silenced = silenced
|
|
|
|
}
|
|
|
|
|
|
|
|
// WithUnprocessed adds the unprocessed to the get alerts params
|
|
|
|
func (o *GetAlertsParams) WithUnprocessed(unprocessed *bool) *GetAlertsParams {
|
|
|
|
o.SetUnprocessed(unprocessed)
|
|
|
|
return o
|
|
|
|
}
|
|
|
|
|
|
|
|
// SetUnprocessed adds the unprocessed to the get alerts params
|
|
|
|
func (o *GetAlertsParams) SetUnprocessed(unprocessed *bool) {
|
|
|
|
o.Unprocessed = unprocessed
|
|
|
|
}
|
|
|
|
|
|
|
|
// WriteToRequest writes these params to a swagger request
|
|
|
|
func (o *GetAlertsParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error {
|
|
|
|
|
|
|
|
if err := r.SetTimeout(o.timeout); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
var res []error
|
|
|
|
|
|
|
|
if o.Active != nil {
|
|
|
|
|
|
|
|
// query param active
|
|
|
|
var qrActive bool
|
|
|
|
if o.Active != nil {
|
|
|
|
qrActive = *o.Active
|
|
|
|
}
|
|
|
|
qActive := swag.FormatBool(qrActive)
|
|
|
|
if qActive != "" {
|
|
|
|
if err := r.SetQueryParam("active", qActive); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
valuesFilter := o.Filter
|
|
|
|
|
2019-03-08 08:24:46 +00:00
|
|
|
joinedFilter := swag.JoinByFormat(valuesFilter, "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
|
|
|
// query array param filter
|
|
|
|
if err := r.SetQueryParam("filter", joinedFilter...); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
if o.Inhibited != nil {
|
|
|
|
|
|
|
|
// query param inhibited
|
|
|
|
var qrInhibited bool
|
|
|
|
if o.Inhibited != nil {
|
|
|
|
qrInhibited = *o.Inhibited
|
|
|
|
}
|
|
|
|
qInhibited := swag.FormatBool(qrInhibited)
|
|
|
|
if qInhibited != "" {
|
|
|
|
if err := r.SetQueryParam("inhibited", qInhibited); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
if o.Receiver != nil {
|
|
|
|
|
|
|
|
// query param receiver
|
|
|
|
var qrReceiver string
|
|
|
|
if o.Receiver != nil {
|
|
|
|
qrReceiver = *o.Receiver
|
|
|
|
}
|
|
|
|
qReceiver := qrReceiver
|
|
|
|
if qReceiver != "" {
|
|
|
|
if err := r.SetQueryParam("receiver", qReceiver); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
if o.Silenced != nil {
|
|
|
|
|
|
|
|
// query param silenced
|
|
|
|
var qrSilenced bool
|
|
|
|
if o.Silenced != nil {
|
|
|
|
qrSilenced = *o.Silenced
|
|
|
|
}
|
|
|
|
qSilenced := swag.FormatBool(qrSilenced)
|
|
|
|
if qSilenced != "" {
|
|
|
|
if err := r.SetQueryParam("silenced", qSilenced); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
if o.Unprocessed != nil {
|
|
|
|
|
|
|
|
// query param unprocessed
|
|
|
|
var qrUnprocessed bool
|
|
|
|
if o.Unprocessed != nil {
|
|
|
|
qrUnprocessed = *o.Unprocessed
|
|
|
|
}
|
|
|
|
qUnprocessed := swag.FormatBool(qrUnprocessed)
|
|
|
|
if qUnprocessed != "" {
|
|
|
|
if err := r.SetQueryParam("unprocessed", qUnprocessed); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
if len(res) > 0 {
|
|
|
|
return errors.CompositeValidationError(res...)
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|