Argo · API Governance Rules
Argo API Rules
Spectral linting rules defining API design standards and conventions for Argo.
9 Rules
error 6
warn 2
info 1
Rule Categories
info
no
operation
paths
response
Rules
error
info-title-required
API title must be present
$.info
error
info-description-required
API must have a description
$.info
error
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,delete,patch]
error
operation-operationid-required
Every operation must have an operationId
$.paths[*][get,post,put,delete,patch]
warn
operation-tags-required
Operations should be tagged
$.paths[*][get,post,put,delete,patch]
info
paths-versioned
All paths should be versioned
$.paths[*]~
error
response-success-required
Every operation must define at least one response
$.paths[*][get,post,put,delete,patch].responses
warn
response-description-required
All responses must have a description
$.paths[*][get,post,put,delete,patch].responses[*]
error
no-empty-summaries
Summaries must not be empty
$.paths[*][get,post,put,delete,patch].summary