mirror of
https://github.com/prometheus/alertmanager
synced 2025-02-27 00:00:43 +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>
120 lines
3.0 KiB
Go
120 lines
3.0 KiB
Go
// Code generated by running "go generate" in golang.org/x/text. DO NOT EDIT.
|
|
|
|
package idna
|
|
|
|
// This file contains definitions for interpreting the trie value of the idna
|
|
// trie generated by "go run gen*.go". It is shared by both the generator
|
|
// program and the resultant package. Sharing is achieved by the generator
|
|
// copying gen_trieval.go to trieval.go and changing what's above this comment.
|
|
|
|
// info holds information from the IDNA mapping table for a single rune. It is
|
|
// the value returned by a trie lookup. In most cases, all information fits in
|
|
// a 16-bit value. For mappings, this value may contain an index into a slice
|
|
// with the mapped string. Such mappings can consist of the actual mapped value
|
|
// or an XOR pattern to be applied to the bytes of the UTF8 encoding of the
|
|
// input rune. This technique is used by the cases packages and reduces the
|
|
// table size significantly.
|
|
//
|
|
// The per-rune values have the following format:
|
|
//
|
|
// if mapped {
|
|
// if inlinedXOR {
|
|
// 15..13 inline XOR marker
|
|
// 12..11 unused
|
|
// 10..3 inline XOR mask
|
|
// } else {
|
|
// 15..3 index into xor or mapping table
|
|
// }
|
|
// } else {
|
|
// 15..14 unused
|
|
// 13 mayNeedNorm
|
|
// 12..11 attributes
|
|
// 10..8 joining type
|
|
// 7..3 category type
|
|
// }
|
|
// 2 use xor pattern
|
|
// 1..0 mapped category
|
|
//
|
|
// See the definitions below for a more detailed description of the various
|
|
// bits.
|
|
type info uint16
|
|
|
|
const (
|
|
catSmallMask = 0x3
|
|
catBigMask = 0xF8
|
|
indexShift = 3
|
|
xorBit = 0x4 // interpret the index as an xor pattern
|
|
inlineXOR = 0xE000 // These bits are set if the XOR pattern is inlined.
|
|
|
|
joinShift = 8
|
|
joinMask = 0x07
|
|
|
|
// Attributes
|
|
attributesMask = 0x1800
|
|
viramaModifier = 0x1800
|
|
modifier = 0x1000
|
|
rtl = 0x0800
|
|
|
|
mayNeedNorm = 0x2000
|
|
)
|
|
|
|
// A category corresponds to a category defined in the IDNA mapping table.
|
|
type category uint16
|
|
|
|
const (
|
|
unknown category = 0 // not currently defined in unicode.
|
|
mapped category = 1
|
|
disallowedSTD3Mapped category = 2
|
|
deviation category = 3
|
|
)
|
|
|
|
const (
|
|
valid category = 0x08
|
|
validNV8 category = 0x18
|
|
validXV8 category = 0x28
|
|
disallowed category = 0x40
|
|
disallowedSTD3Valid category = 0x80
|
|
ignored category = 0xC0
|
|
)
|
|
|
|
// join types and additional rune information
|
|
const (
|
|
joiningL = (iota + 1)
|
|
joiningD
|
|
joiningT
|
|
joiningR
|
|
|
|
//the following types are derived during processing
|
|
joinZWJ
|
|
joinZWNJ
|
|
joinVirama
|
|
numJoinTypes
|
|
)
|
|
|
|
func (c info) isMapped() bool {
|
|
return c&0x3 != 0
|
|
}
|
|
|
|
func (c info) category() category {
|
|
small := c & catSmallMask
|
|
if small != 0 {
|
|
return category(small)
|
|
}
|
|
return category(c & catBigMask)
|
|
}
|
|
|
|
func (c info) joinType() info {
|
|
if c.isMapped() {
|
|
return 0
|
|
}
|
|
return (c >> joinShift) & joinMask
|
|
}
|
|
|
|
func (c info) isModifier() bool {
|
|
return c&(modifier|catSmallMask) == modifier
|
|
}
|
|
|
|
func (c info) isViramaModifier() bool {
|
|
return c&(attributesMask|catSmallMask) == viramaModifier
|
|
}
|