experience-pagination.html

Consistent paging of collection responses.

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

Ruleset definition

Download YAML 

Loading…

Rules in this ruleset (11)

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 Post Collection Require Paging Object (Swagger 2.0) OpenAPI
Response Collection Require Results Array OpenAPI
Response Collection Require Results Array (Swagger 2.0) OpenAPI
Response Collection Support Paging OpenAPI
Response Collection Support Paging (Swagger 2.0) OpenAPI
Response Get Link Header OpenAPI
Schema Collection Require Pagination Params OpenAPI

← All experience rulesets