AsyncAPI Best Practices

general > asyncapi-info-description

Guidance

AsyncAPI object info description must be present and be a non-empty string.

Examples can contain Markdown, so you can provide as much getting started information as you want,
like where to find authentication keys, and how to use them.

Message

Provide a description for the API.

Examples

valid

asyncapi: 2.0.0
info:
  title: example API
  version: "1.0.0"
  description: Example
channels: {}

invalid

asyncapi: 2.0.0
info:
  title: example API
  version: "1.0.0"
channels: {}

Applies to AsyncAPI

Constraint

Type: Declarative Validation