experience-pagination.html

Consistent paging of collection responses.

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

Ruleset definition

Download YAML 

Loading…

Rules in this ruleset (8)

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
Response Collection Require Results Array OpenAPI
Response Collection Support Paging OpenAPI
Response Get Link Header OpenAPI
Schema Collection Require Pagination Params OpenAPI

← All experience rulesets