AMQP · API Governance Rules
AMQP API Rules
Spectral linting rules defining API design standards and conventions for AMQP.
9 Rules
error 2
warn 5
info 2
Rule Categories
asyncapi
Rules
error
asyncapi-info-description
AsyncAPI info must have a description
$.info
error
asyncapi-info-version
AsyncAPI info must have a version
$.info
warn
asyncapi-servers-defined
At least one server must be defined
$
warn
asyncapi-channel-description
Every channel should have a description
$.channels[*]
warn
asyncapi-message-description
Every message should have a description
$.components.messages[*]
info
asyncapi-schema-type
Schema properties should have explicit types
$.components.schemas[*].properties[*]
info
asyncapi-amqp-exchange-type
AMQP bindings should define exchange type
$.channels[*].bindings.amqp.exchange
warn
asyncapi-operation-id
Operations should have an operationId
$.channels[*].messages[*]
warn
asyncapi-no-empty-description
Descriptions must not be empty
$..description