AsyncAPI Best Practices

general > asyncapi-tag-description

Guidance

Tags alone are not very descriptive, so use descriptions to explain them.

For example, an 'Account' could be a user account, company information, bank account, or potential sales lead.

Message

Tag "{{core.name}}" should have a description.

Examples

valid

asyncapi: 2.0.0
tags:
  - name: example
    description: example API
info:
  title: example API
  version: "1.0.0"
channels: {}

invalid

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

Applies to Tag

Constraint

Type: Declarative Validation