Circle · API Governance Rules
Circle API Rules
Spectral linting rules defining API design standards and conventions for Circle.
9 Rules
error 4
warn 4
info 1
Rule Categories
circle
Rules
error
circle-info-contact
API contact information must be present.
$.info
error
circle-server-https
All server URLs must use HTTPS.
$.servers[*].url
warn
circle-server-base-path
api.circle.com servers must include /v1.
$.servers[?(@.url && @.url.indexOf('api.circle.com') > -1)].url
error
circle-bearer-security
A bearer-token security scheme must be defined.
$.components.securitySchemes[*]
error
circle-operation-id
Every operation must declare a unique operationId.
$.paths[*][get,post,put,patch,delete]
warn
circle-operation-tags
Operations must declare at least one tag.
$.paths[*][get,post,put,patch,delete]
warn
circle-idempotency-key
POST operations should accept an X-Idempotency-Key header.
$.paths[*].post
warn
circle-error-responses
Mutating operations should declare 4xx/5xx error responses.
$.paths[*][post,put,patch,delete].responses
info
circle-uuid-identifiers
Path parameters named "id" should be UUIDs.
$.paths[*].*.parameters[?(@.in == 'path' && @.name == 'id')].schema