asyncapi-info-description
asyncapi-info-description requires the document to explain what the event API is for.
Why did this violation appear?
The root info.description field is missing or empty.
Bad example
asyncapi: 3.1.0
info:
title: User events
version: 1.0.0
Good example
asyncapi: 3.1.0
info:
title: User events
version: 1.0.0
description: Events emitted by the user lifecycle service.
contact:
name: API Platform
url: https://example.com/support
email: api@example.com
license:
name: MIT
url: https://opensource.org/licenses/MIT
How do I fix this violation?
Add a concise description of the business capability, audience, and event family.