ARGUS Enterprise · API Governance Rules
ARGUS Enterprise API Rules
Spectral linting rules defining API design standards and conventions for ARGUS Enterprise.
14 Rules
error 5
warn 7
info 2
Rule Categories
info
no
operation
parameter
paths
response
schema
security
Rules
warn
info-title-prefix
API title should start with "Argus Enterprise"
$.info.title
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]
warn
operation-summary-prefix
Summaries should start with "Argus Enterprise"
$.paths[*][get,post,put,delete,patch].summary
error
operation-operationid-required
Every operation must have an operationId
$.paths[*][get,post,put,delete,patch]
warn
operation-tags-required
Operations must be tagged
$.paths[*][get,post,put,delete,patch]
info
paths-versioned
Paths should be versioned
$.paths[*]~
warn
paths-kebab-case
Path segments should use kebab-case
$.paths[*]~
error
response-success-required
Every operation must define responses
$.paths[*][get,post,put,delete,patch].responses
warn
response-description-required
All responses must have descriptions
$.paths[*][get,post,put,delete,patch].responses[*]
warn
security-definitions-required
API must define security schemes
$
info
schema-properties-description
Schema properties should have descriptions
$.components.schemas[*].properties[*]
error
no-empty-summaries
Summaries must not be empty
$.paths[*][get,post,put,delete,patch].summary
warn
parameter-description-required
Parameters should have descriptions
$.paths[*][get,post,put,delete,patch].parameters[*]