Cisco Control Hub · API Governance Rules

Cisco Control Hub API Rules

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

8 Rules error 3 warn 4 info 1

webex

error

webex-info-contact

API contact information must be present.

$.info

error

webex-server-https

All server URLs must use HTTPS.

$.servers[*].url

warn

webex-server-base-path

webexapis.com servers must include /v1.

$.servers[?(@.url && @.url.indexOf('webexapis.com') > -1)].url

warn

webex-oauth-security

An OAuth 2.0 security scheme must be defined.

$.components.securitySchemes[*]

error

webex-operation-id

Every operation must declare a unique operationId.

$.paths[*][get,post,put,patch,delete]

warn

webex-operation-tags

Operations must declare at least one tag.

$.paths[*][get,post,put,patch,delete]

info

webex-pagination-cursor

List endpoints should support max/cursor or start pagination.

$.paths[*].get.parameters[*].name

warn

webex-error-responses

Mutating operations should declare 4xx/5xx error responses.

$.paths[*][post,put,patch,delete].responses