ClickHouse · API Governance Rules
ClickHouse API Rules
Spectral linting rules defining API design standards and conventions for ClickHouse.
9 Rules
error 4
warn 5
Rule Categories
clickhouse
Rules
error
clickhouse-info-contact
API contact information must be present.
$.info
warn
clickhouse-info-license
API license must be declared.
$.info
error
clickhouse-server-https
All server URLs must use HTTPS for the Cloud control plane.
$.servers[?(@.url && @.url.indexOf('clickhouse.cloud') > -1)].url
warn
clickhouse-cloud-versioned
ClickHouse Cloud paths must be versioned (/v{N}).
$.paths
error
clickhouse-auth-required
A security scheme (apiKey) must be declared for Cloud APIs.
$.components.securitySchemes
error
clickhouse-operation-id
Every operation must declare a unique operationId.
$.paths[*][get,post,put,patch,delete]
warn
clickhouse-operation-tags
Every operation must declare at least one tag.
$.paths[*][get,post,put,patch,delete]
warn
clickhouse-operation-summary
Every operation must include a short summary.
$.paths[*][get,post,put,patch,delete]
warn
clickhouse-error-responses
Mutating operations should declare 4xx error responses.
$.paths[*][post,put,patch,delete].responses