experience-performance.html

Caching, payload, and efficiency signals that keep the API fast.

29 rules experience: performance 29 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-performance.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 29 are inlined in the file below.

Ruleset definition

Download YAML 

Loading…

Rules in this ruleset (29)

Schema Include Rate Limit Reference APIs.json
Document Cache Control Parameter OpenAPI
Document Cache Response Header OpenAPI
Operation Collection Support Filtering OpenAPI
Operation Collection Support Sorting OpenAPI
Operation Collection Support Sparse Fieldsets OpenAPI
Operation Define 429 Response OpenAPI
Parameter Collection Limit Param Default OpenAPI
Parameter Collection Limit Param Maximum OpenAPI
Parameter Pagination Params In Query OpenAPI
Request Post Collection Require Paging Object OpenAPI
Request Support Accept Encoding OpenAPI
Response 202 Retry After OpenAPI
Response Cache Header No Conflict OpenAPI
Response Collection Require Results Array OpenAPI
Response Collection Support Paging OpenAPI
Response Define 429 OpenAPI
Response Get Cache Control OpenAPI
Response Get ETag OpenAPI
Response Get Last Modified OpenAPI
Response Get Link Header OpenAPI
Response Get Vary OpenAPI
Response Include Ratelimit Header OpenAPI
Response Ratelimit Header OpenAPI
Response Ratelimit Policy OpenAPI
Response Success Require Ratelimit Header OpenAPI
Response Throttled Require Retry After OpenAPI
Response Write ETag OpenAPI
Schema Collection Require Pagination Params OpenAPI

← All experience rulesets