Apache ActiveMQ · API Governance Rules
Apache ActiveMQ API Rules
Spectral linting rules defining API design standards and conventions for Apache ActiveMQ.
19 Rules
error 8
warn 9
info 2
Rule Categories
delete
get
info
operation
parameter
response
security
servers
Rules
warn
info-title-prefix
API title must start with "Apache ActiveMQ"
$.info.title
error
info-description-required
API must have a description of at least 50 characters.
$.info
error
info-version-required
API info must include a version.
$.info
warn
info-license-required
API must declare an Apache 2.0 license.
$.info
error
servers-defined
At least one server must be defined.
$
info
servers-https-only
Server URLs should use HTTPS in production.
$.servers[*].url
error
operation-summary-required
Every operation must have a summary.
$.paths[*][get,post,put,patch,delete,options,head]
warn
operation-summary-title-case
Operation summaries must start with "Apache ActiveMQ".
$.paths[*][get,post,put,patch,delete,options,head].summary
warn
operation-description-required
Every operation must have a description.
$.paths[*][get,post,put,patch,delete,options,head]
error
operation-operationId-required
Every operation must have an operationId.
$.paths[*][get,post,put,patch,delete,options,head]
warn
operation-operationId-camelCase
operationId must be camelCase.
$.paths[*][get,post,put,patch,delete,options,head].operationId
warn
operation-tags-required
Every operation must have at least one tag.
$.paths[*][get,post,put,patch,delete,options,head]
warn
parameter-description-required
Every parameter must have a description.
$.paths[*][get,post,put,patch,delete,options,head].parameters[*]
error
response-success-required
Every operation must define at least one 2xx response.
$.paths[*][get,post,put,patch,delete,options,head].responses
error
response-description-required
Every response must have a description.
$.paths[*][get,post,put,patch,delete,options,head].responses[*]
warn
security-schemes-defined
Security schemes must be defined in components.
$.components
error
get-no-request-body
GET operations must not have a request body.
$.paths[*].get
warn
delete-no-request-body
DELETE operations should not have a request body.
$.paths[*].delete
info
operation-microcks-extension
Operations should include x-microcks-operation extension for mock server compatibility.
$.paths[*][get,post,put,patch,delete]