asyncapi-parameter-description
asyncapi-parameter-description checks channel and component parameters for a useful description.
Why did this violation appear?
A parameter object is missing description or the value is empty.
Bad example
asyncapi: 3.1.0
channels:
userEvents:
address: users/{userId}
parameters:
userId: {}
Good example
asyncapi: 3.1.0
channels:
userEvents:
address: users/{userId}
parameters:
userId:
description: Unique user identifier.
How do I fix this violation?
Describe what the parameter means, not just its name.
