Clockodo · API Governance Rules

Clockodo API Rules

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

6 Rules error 4 warn 2

clockodo

warn

clockodo-info-contact

API info MUST contain a contact email or URL.

$.info

error

clockodo-https-only

All Clockodo API servers MUST use HTTPS.

$.servers[*].url

error

clockodo-operation-id

Operations MUST have an operationId.

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

warn

clockodo-tag-required

Operations MUST be tagged for resource grouping (Entries, Customers, Projects, Services, Users, Absences, LumpSumServices, HolidaysQuota, Clock).

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

error

clockodo-auth-required

API MUST define API-key and/or basic-auth security since Clockodo authenticates with X-ClockodoApiUser/X-ClockodoApiKey headers or HTTP Basic.

$.components.securitySchemes

error

clockodo-server-url

API MUST declare at least one server URL pointing at my.clockodo.com.

$.servers