Cisco · API Governance Rules
Cisco API Rules
Spectral linting rules defining API design standards and conventions for Cisco.
12 Rules
error 5
warn 6
info 1
Rule Categories
info
operation
parameter
paths
response
schema
security
Rules
warn
info-title-prefix
Info title should start with "Cisco"
$.info
error
info-description-required
Info description must be present
$.info
warn
paths-kebab-case
Paths should use kebab-case
$.paths
error
operation-operationId-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete]
error
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-prefix
Operation summaries should start with "Cisco"
$.paths[*][get,post,put,patch,delete]
warn
operation-tags-required
Every operation must have tags
$.paths[*][get,post,put,patch,delete]
warn
parameter-description-required
Every parameter must have a description
$.paths[*][get,post,put,patch,delete].parameters[*]
error
response-success-required
Every operation must have a success response
$.paths[*][get,post,put,patch,delete].responses
error
security-global-defined
Global security must be defined
$
warn
security-api-key-header
API keys should be sent in headers
$.components.securitySchemes[*]
info
schema-properties-description
Schema properties should have descriptions
$.components.schemas[*].properties[*]