Climatiq · API Governance Rules

Climatiq API Rules

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

6 Rules error 4 warn 2

View Rules File View on GitHub

Rule Categories

climatiq

Rules

warn

climatiq-info-contact

API info MUST contain a contact email or URL.

$.info

error

climatiq-https-only

All Climatiq API servers MUST use HTTPS.

$.servers[*].url

error

climatiq-operation-id

Operations MUST have an operationId.

$.paths[*][get,post,put,delete,patch]

warn

climatiq-tag-required

Operations MUST be tagged for product-domain grouping (Search, Estimate, Travel, Freight, Energy, Computing, Procurement, Autopilot, Classifications, CBAM).

$.paths[*][get,post,put,delete,patch].tags

error

climatiq-bearer-auth-required

API MUST define a bearer-token security scheme since Climatiq authenticates with API keys passed as Bearer tokens.

$.components.securitySchemes

error

climatiq-server-url

API MUST declare at least one server URL (api.climatiq.io).

$.servers