Cisco Expressway · API Governance Rules
Cisco Expressway API Rules
Spectral linting rules defining API design standards and conventions for Cisco Expressway.
8 Rules
error 4
warn 3
info 1
Rule Categories
expressway
Rules
error
expressway-info-contact
API contact information must be present.
$.info
error
expressway-server-https
All server URLs must use HTTPS.
$.servers[*].url
warn
expressway-server-base-path
Servers must include /api/provisioning or /api/status.
$.servers[*].url
error
expressway-basic-auth
A basic-auth security scheme must be defined.
$.components.securitySchemes[*]
error
expressway-operation-id
Every operation must declare a unique operationId.
$.paths[*][get,post,put,patch,delete]
warn
expressway-operation-tags
Operations must declare at least one tag.
$.paths[*][get,post,put,patch,delete]
info
expressway-zone-collection-naming
Provisioning collection paths should be plural nouns.
$.paths[?(@property.indexOf('/api/provisioning/') > -1)]~
warn
expressway-error-responses
Mutating operations should declare 4xx error responses.
$.paths[*][post,put,patch,delete].responses