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
View Rules File View on GitHub

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

Spectral Ruleset

Raw ↑ 
extends:
  - spectral:oas
  - spectral:asyncapi
rules:
  cisco-hardware-info-contact:
    description: API info object MUST contain a contact for Cisco Hardware APIs.
    severity: warn
    given: $.info
    then:
      field: contact
      function: truthy
  cisco-hardware-https-only:
    description: All Cisco Hardware API servers MUST use HTTPS.
    severity: error
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: '^https://'
  cisco-hardware-tag-required:
    description: Operations MUST be tagged for hardware domain grouping.
    severity: warn
    given: $.paths[*][get,post,put,delete,patch].tags
    then:
      function: truthy
  cisco-hardware-operation-id:
    description: Operations MUST have an operationId.
    severity: error
    given: $.paths[*][get,post,put,delete,patch]
    then:
      field: operationId
      function: truthy
  cisco-hardware-summary-required:
    description: Operations MUST have a summary.
    severity: warn
    given: $.paths[*][get,post,put,delete,patch]
    then:
      field: summary
      function: truthy
  cisco-hardware-security-required:
    description: API MUST define security schemes for token, basic-auth, or signature auth.
    severity: error
    given: $.components.securitySchemes
    then:
      function: truthy

Work with this as data

Every ruleset here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for spectral rules

4 MCP tools reach this
  • find_rulesBrowse and filter every ruleset in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This ruleset 
curl "https://apis.io/api/v1/rules/cisco-hardware-rules"
All spectral rules 
curl "https://apis.io/api/v1/rules?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.