Cisco Hardware · API Governance Rules
Cisco Hardware API Rules
Spectral linting rules defining API design standards and conventions for Cisco Hardware.
6 Rules
error 3
warn 3
Rule Categories
cisco
Rules
warn
cisco-hardware-info-contact
API info object MUST contain a contact for Cisco Hardware APIs.
$.info
error
cisco-hardware-https-only
All Cisco Hardware API servers MUST use HTTPS.
$.servers[*].url
warn
cisco-hardware-tag-required
Operations MUST be tagged for hardware domain grouping.
$.paths[*][get,post,put,delete,patch].tags
error
cisco-hardware-operation-id
Operations MUST have an operationId.
$.paths[*][get,post,put,delete,patch]
warn
cisco-hardware-summary-required
Operations MUST have a summary.
$.paths[*][get,post,put,delete,patch]
error
cisco-hardware-security-required
API MUST define security schemes for token, basic-auth, or signature auth.
$.components.securitySchemes