asyncapi-3-operation-description
asyncapi-3-operation-description ensures every operation explains what the event flow represents.
Why did this violation appear?
An operation is missing description or the value is empty.
Bad example
asyncapi: 3.1.0
channels: {}
operations:
receiveUserCreated:
action: receive
messages:
- $ref: '#/components/messages/MissingMessage'
components:
messages: {}
Good example
asyncapi: 3.1.0
channels:
userCreated:
address: users/created
operations:
receiveUserCreated:
action: receive
description: Receive user creation events.
channel:
$ref: '#/channels/userCreated'
messages:
- $ref: '#/components/messages/UserCreated'
components:
messages:
UserCreated:
payload:
type: object
How do I fix this violation?
Add a concise description that explains the event flow from the consumer or producer perspective.