Cisco Systems · API Governance Rules

Cisco Systems API Rules

Spectral linting rules defining API design standards and conventions for Cisco Systems.

6 Rules error 4 warn 2
View Rules File View on GitHub

Rule Categories

cisco

Rules

warn
cisco-info-contact
API info MUST contain a contact email or URL.
$.info
error
cisco-https-only
All Cisco Systems API servers MUST use HTTPS.
$.servers[*].url
error
cisco-operation-id
Operations MUST have an operationId.
$.paths[*][get,post,put,delete,patch]
warn
cisco-tag-required
Operations MUST be tagged for product domain grouping.
$.paths[*][get,post,put,delete,patch].tags
error
cisco-security-required
API MUST define security schemes.
$.components.securitySchemes
error
cisco-server-url
API MUST declare at least one server URL.
$.servers