Tempo · API Governance Rules
Tempo API Rules
Spectral linting rules defining API design standards and conventions for Tempo.
9 Rules
error 2
warn 6
info 1
Rule Categories
tempo
Rules
info
tempo-no-auth-required
Tempo HTTP API is an internal service API without authentication by design
$.paths[*][get,post,put,delete].security
error
tempo-operation-id-required
All operations must have an operationId
$.paths[*][get,post,put,patch,delete]
warn
tempo-operation-id-camel-case
OperationIds should use camelCase
$.paths[*][get,post,put,patch,delete].operationId
warn
tempo-summary-title-case
Operation summaries must use Title Case
$.paths[*][get,post,put,patch,delete].summary
warn
tempo-operation-tags-required
All operations must have at least one tag
$.paths[*][get,post,put,patch,delete]
warn
tempo-operation-description-required
All operations must have a description
$.paths[*][get,post,put,patch,delete]
warn
tempo-traceid-pattern
traceID path parameters should enforce hex format
$.paths[*].parameters[?(@.name=='traceID')].schema
error
tempo-server-urls-required
API spec must define server URLs
$
warn
tempo-success-response-schema
Successful responses should include a schema
$.paths[*][get].responses.200.content.application/json