Axon Framework · API Governance Rules
Axon Framework API Rules
Spectral linting rules defining API design standards and conventions for Axon Framework.
5 Rules
error 3
warn 1
info 1
Rule Categories
axon
Rules
warn
axon-operation-summary
All operations must have a summary starting with "Axon Framework"
$.paths[*][get,post,put,delete,patch]
error
axon-operation-id
All operations must have an operationId
$.paths[*][get,post,put,delete,patch]
error
axon-info-title
Info object must have a title
$.info
error
axon-response-description
All responses must have a description
$.paths[*][*].responses[*]
info
axon-microcks-annotation
Operations should have x-microcks-operation annotation
$.paths[*][get,post,put,delete,patch]