Apache Atlas · API Governance Rules
Apache Atlas API Rules
Spectral linting rules defining API design standards and conventions for Apache Atlas.
12 Rules
error 7
warn 5
Rule Categories
get
info
operation
parameter
response
security
servers
Rules
warn
info-title-prefix
API title must start with "Apache Atlas"
$.info.title
error
info-description-required
$.info
error
servers-defined
$
error
operation-summary-required
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-starts-with-apache-atlas
$.paths[*][get,post,put,patch,delete].summary
error
operation-operationId-required
$.paths[*][get,post,put,patch,delete]
warn
operation-tags-required
$.paths[*][get,post,put,patch,delete]
warn
parameter-description-required
$.paths[*][get,post,put,patch,delete].parameters[*]
error
response-success-required
$.paths[*][get,post,put,patch,delete].responses
error
response-description-required
$.paths[*][get,post,put,patch,delete].responses[*]
warn
security-schemes-defined
$.components
error
get-no-request-body
$.paths[*].get