experience-observability.html

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

7 rules experience: observability 7 inlined · 0 from the engine

Run this ruleset

Lint any matching artifact against this ruleset with the Spotlight CLI:

npm i -g @spotlight-rules/spotlight-cli
spotlight lint api.yaml \
  --ruleset https://apicommons.org/assets/rulesets/experience-observability.spotlight.yaml

Or load it into the browser validator, post it to the HTTP API, or wire it into a CI gate. 0 of these rules are the engine's built-ins (they come with spotlight:*); 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