AsyncAPI support

Current support state
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.
Currently supported
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).
Partially supported: message object payload
Message#payload could be of any type according to the specification, but we only support SchemaObject type.
Partially supported: server security and securitySchemes
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.
anyOf/oneOf
The oneOf/anyOf support was one of the most expected features to come. The team is currently working on supporting it: we are currently looking for beta testers, feel free to contact us!
Add topics to your documentation
As this is not supported by AsyncAPI, we created a custom property to enrich your documentation. Find out more in our dedicated section.

Webhooks

API change management

Last modified 10d ago

Copy link

Outline

Current support state

Currently supported

Partially supported: message object payload

Partially supported: server security and securitySchemes

anyOf/oneOf

Add topics to your documentation

Current support state

Currently supported

Partially supported: message object `payload`

Partially supported: server `security` and `securitySchemes`

`anyOf/oneOf`

Add topics to your documentation