CircleCI · API Governance Rules
CircleCI API Rules
Spectral linting rules defining API design standards and conventions for CircleCI.
10 Rules
error 4
warn 5
info 1
Rule Categories
circleci
Rules
error
circleci-info-contact
API contact information must be present.
$.info
warn
circleci-info-license
API license must be declared.
$.info
error
circleci-server-https
All server URLs must use HTTPS.
$.servers[*].url
warn
circleci-server-versioned
REST v2 server URLs must include /api/v2.
$.servers[?(@.url && @.url.indexOf('circleci.com') > -1)].url
error
circleci-token-security
A Circle-Token API key security scheme must be defined.
$.components.securitySchemes
warn
circleci-operation-tags
Every operation must declare at least one tag.
$.paths[*][get,post,put,patch,delete]
warn
circleci-operation-summary
Every operation must include a short summary.
$.paths[*][get,post,put,patch,delete]
error
circleci-operation-id
Every operation must declare a unique operationId.
$.paths[*][get,post,put,patch,delete]
warn
circleci-error-responses
Mutating operations should declare 4xx/5xx error responses.
$.paths[*][post,put,patch,delete].responses
info
circleci-pagination-cursor
List endpoints should support page-token pagination.
$.paths[?(@property.match(/list$|projects$|workflows$|jobs$|pipelines$/))].get.parameters[*].name