Argo CD · API Governance Rules
Argo CD API Rules
Spectral linting rules defining API design standards and conventions for Argo CD.
18 Rules
error 7
warn 9
info 2
Rule Categories
get
info
no
operation
parameter
paths
response
security
Rules
warn
info-title-prefix
API title must start with "Argo CD"
$.info.title
error
info-description-required
API must have a description
$.info
error
info-version-required
API must have a version
$.info
error
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,delete,patch]
warn
operation-summary-title-case
Operation summaries must start with "Argo CD"
$.paths[*][get,post,put,delete,patch].summary
warn
operation-description-required
Every operation must have a description
$.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
Every operation must have at least one tag
$.paths[*][get,post,put,delete,patch]
warn
paths-kebab-case
Path segments should use kebab-case
$.paths[*]~
warn
paths-no-trailing-slash
Paths must not have trailing slashes
$.paths[*]~
info
paths-versioned
All paths should be versioned with /api/v1/
$.paths[*]~
warn
parameter-description-required
All parameters must have a description
$.paths[*][get,post,put,delete,patch].parameters[*]
error
response-success-required
Every operation must have a success 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[*]
warn
security-definitions-required
API must define security schemes
$
error
get-no-request-body
GET operations must not have a request body
$.paths[*].get
error
no-empty-summaries
Summaries must not be empty strings
$.paths[*][get,post,put,delete,patch].summary
info
operation-id-camel-case
OperationIds should use camelCase or ServiceName_MethodName pattern
$.paths[*][get,post,put,delete,patch].operationId