Skip to content

TypeScript API / contentia/json-api / paginationParameters

Function: paginationParameters() ​

ts
function paginationParameters(options): OpenApiParameter[];

The six page[*] query parameters understood by parsePaginationQuery.

Sizes outside 1..MAX_PAGE_SIZE are clamped rather than rejected, page[limit] is read only alongside page[offset], and cursor parameters are refused with 400 by backends that do not declare cursor support. All documented here so the behaviour is described identically on every listing endpoint.

Parameters ​

ParameterType
optionsPaginationParameterOptions

Returns ​

OpenApiParameter[]