Clerk.io · API Governance Rules
Clerk.io API Rules
Spectral linting rules defining API design standards and conventions for Clerk.io.
8 Rules
error 4
warn 4
Rule Categories
clerk
Rules
error
clerk-io-info-contact
API contact information must be present.
$.info
warn
clerk-io-info-license
API license must be declared.
$.info
error
clerk-io-server-https
All server URLs must use HTTPS.
$.servers[*].url
error
clerk-io-auth-required
A security scheme (apiKey for public/private keys) must be declared.
$.components.securitySchemes
error
clerk-io-operation-id
Every operation must declare a unique operationId.
$.paths[*][get,post,put,patch,delete]
warn
clerk-io-operation-tags
Every operation must declare at least one tag.
$.paths[*][get,post,put,patch,delete]
warn
clerk-io-operation-summary
Every operation must include a short summary.
$.paths[*][get,post,put,patch,delete]
warn
clerk-io-error-responses
Mutating operations should declare 4xx error responses.
$.paths[*][post,put,patch,delete].responses