mirror of
https://github.com/prometheus/alertmanager
synced 2025-01-22 14:03:10 +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>
23 lines
1.3 KiB
Plaintext
23 lines
1.3 KiB
Plaintext
Additional IP Rights Grant (Patents)
|
|
|
|
"This implementation" means the copyrightable works distributed by
|
|
Google as part of the Go project.
|
|
|
|
Google hereby grants to You a perpetual, worldwide, non-exclusive,
|
|
no-charge, royalty-free, irrevocable (except as stated in this section)
|
|
patent license to make, have made, use, offer to sell, sell, import,
|
|
transfer and otherwise run, modify and propagate the contents of this
|
|
implementation of Go, where such license applies only to those patent
|
|
claims, both currently owned or controlled by Google and acquired in
|
|
the future, licensable by Google that are necessarily infringed by this
|
|
implementation of Go. This grant does not include claims that would be
|
|
infringed only as a consequence of further modification of this
|
|
implementation. If you or your agent or exclusive licensee institute or
|
|
order or agree to the institution of patent litigation against any
|
|
entity (including a cross-claim or counterclaim in a lawsuit) alleging
|
|
that this implementation of Go or any code incorporated within this
|
|
implementation of Go constitutes direct or contributory patent
|
|
infringement, or inducement of patent infringement, then any patent
|
|
rights granted to you under this License for this implementation of Go
|
|
shall terminate as of the date such litigation is filed.
|