Clarivate · API Governance Rules

Clarivate API Rules

Spectral linting rules defining API design standards and conventions for Clarivate.

6 Rules error 4 warn 2
View Rules File View on GitHub

Rule Categories

clarivate

Rules

warn
clarivate-info-contact
API info MUST contain a contact email or URL.
$.info
error
clarivate-https-only
All Clarivate API servers MUST use HTTPS.
$.servers[*].url
error
clarivate-operation-id
Operations MUST have an operationId.
$.paths[*][get,post,put,delete,patch]
warn
clarivate-tag-required
Operations MUST be tagged for product domain grouping.
$.paths[*][get,post,put,delete,patch].tags
error
clarivate-security-required
API MUST define API key security schemes.
$.components.securitySchemes
error
clarivate-server-url
API MUST declare at least one server URL.
$.servers