Argo · API Governance Rules
Argo API Rules
Spectral linting rules defining API design standards and conventions for Argo.
16 Rules
error 7
warn 7
info 2
Rule Categories
info
no
operation
operationid
path
paths
response
schema
security
servers
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
error
servers-https-only
Server URLs must use HTTPS.
$.servers[*].url
warn
path-params-casing
Path parameters should be snake_case (the dominant convention in this API).
$.paths[*].parameters[?(@.in=='path')].name
warn
operationid-casing
Operation IDs should be camelCase (the dominant convention in this API).
$.paths[*][get,post,put,patch,delete].operationId
warn
schema-names-casing
Component schema names should be PascalCase (the dominant convention in this API).
$.components.schemas
info
schema-properties-casing
Schema properties should be snake_case (the dominant convention in this API).
$.components.schemas[*].properties
warn
security-schemes-defined
Security schemes should be defined in components.
$.components
warn
no-empty-descriptions
Descriptions must not be empty strings.
$..description