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