AsyncAPI support
AsyncAPI support is currently in beta test. We are only supporting AsyncAPI 2.x, for JSON event driven APIs.
Event driven APIs world is more complex than REST APIs one: there are more protocols, more tools, more different architectures. As a consequence, AsyncAPI is more complex that OpenAPI to support. We wanted to open our beta fast, so we have chosen to release it with minimal features.
Bump is able to extract:
- root properties (AsyncAPI Object)
- channels (with automatic grouping according to channel name or tag grouping)
- operations (subscribe and publish)
- messages (payload and headers), with examples.
- bindings (server, operation and message).
Message#payload could be of any type according to the specification, but we only support
SchemaObject
type.We support AsyncAPI
securitySchemes
property with these authentication types:http
apiKey
httpApiKey
oauth2
openIdConnect
We do not support
X509
, symmetricEncryption
, asymmetricEncryption
, plain
, scramSha256
, scramSha512
nor gssapi.
To describe these authentication types, please use our custom x-topics
property for now.As this is not supported by AsyncAPI, we created a custom property to enrich your documentation. Find out more in our dedicated section.
Last modified 1mo ago