TypeScript API / laikacms/json-api / paginationParameters

Function: paginationParameters()

function paginationParameters(options): OpenApiParameter[];

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

Sizes above MAX_PAGE_SIZE are clamped rather than rejected, and cursor parameters are refused with 400 by backends that do not declare cursor support — both documented here so the behaviour is described identically on every listing endpoint.

Parameters

Parameter	Type
options	PaginationParameterOptions

Returns

OpenApiParameter[]