AsyncAPI Message Examples (Edit)

AsyncAPI messages should include examples to support event-driven API mocking, testing, and documentation. Examples help consumers understand message payloads and enable tools to generate realistic mock events.

AsyncAPIMessagesExamplesMocking

Rule Definition

asyncapi-message-examples-warn.yaml
{"asyncapi-message-examples-warn":{"description":"AsyncAPI messages should include examples to support event-driven API mocking, testing, and documentation. Examples help consumers understand message payloads and enable tools to generate realistic mock events.","message":"AsyncAPI messages SHOULD include examples.","given":"$.channels[*].subscribe.message,$.channels[*].publish.message","severity":"warn","then":{"field":"examples","function":"truthy"}}}

Back to All of the Rules