AsyncAPI Best Practices

AsyncAPI Best Practices

This ruleset contains 21 best practices based on recommendations from AsyncAPI Specification v2.0.0.

Links:
- AsyncAPI Specification v2.0.0
- AsyncAPI.com
- GitHub asyncapi/spec

Rules in this Ruleset

Violations

• asyncapi-channel-no-empty-parameter
• asyncapi-channel-no-query-nor-fragment
• asyncapi-channel-no-trailing-slash
• asyncapi-server-no-empty-variable
• asyncapi-server-no-trailing-slash

Warnings

• asyncapi-channel-parameters
• asyncapi-headers-schema-type-object
• asyncapi-info-contact
• asyncapi-info-contact-properties
• asyncapi-info-description
• asyncapi-info-license
• asyncapi-operation-description
• asyncapi-operation-operationId
• asyncapi-operation-operationId-uniqueness
• asyncapi-parameter-description
• asyncapi-payload-unsupported-schemaFormat
• asyncapi-server-not-example-com
• asyncapi-servers
• asyncapi-tag-description
• asyncapi-tags
• asyncapi-tags-uniqueness