experience-observability.html

Tracing, correlation, and logging hooks for operating the API.

7 rules experience: observability 7 in the file · 0 built-in or validator-only

Run this ruleset

Lint any matching artifact against this ruleset with the OpenLint CLI (the Spectral CLI gives the same results):

npx openlint lint api.yaml \
  --ruleset https://apicommons.org/assets/rulesets/experience-observability.yaml

Or run every rule, including the 0 that are engine built-ins or need the validator's own functions, in the API Commons validator. The other 7 are inlined in the file below.

Ruleset definition

Download YAML 

Loading…

Rules in this ruleset (7)

Component Asyncapi Message Require Correlation ID AsyncAPI
Path Require Tracing Header OpenAPI
Request Support Baggage OpenAPI
Request Support Correlation ID OpenAPI
Request Support Tracestate OpenAPI
Response Return Correlation ID OpenAPI
Schema Requestid Property Must Be String OpenAPI

← All experience rulesets