Skip to main content
Version: v1.0.0

Untitled object in cw-storage Schema

undefined#/instantiate/definitions/PaginationConfig

PaginationConfig is the type carrying configuration for paginated queries.

The fields are optional and if not set, there is a default configuration.

AbstractExtensibleStatusIdentifiableCustom PropertiesAdditional PropertiesAccess RestrictionsDefined In
Can be instantiatedNoUnknown statusNoForbiddenForbiddennonecw-storage.json*

PaginationConfig Type

object (Details)

PaginationConfig Properties

PropertyTypeRequiredNullableDefined by
default_page_sizeintegerOptionalcan be nullcw-storage
max_page_sizeintegerOptionalcan be nullcw-storage

default_page_size

The default number of elements in a page.

Shall be less or equal than max_page_size. Default to '10' if not set.

default_page_size

  • is optional

  • Type: integer

  • can be null

  • defined in: cw-storage

default_page_size Type

integer

default_page_size Constraints

minimum: the value of this number must greater than or equal to: 0

unknown format: the value of this string must follow the format: uint32

max_page_size

The maximum elements a page can contains.

Shall be less than u32::MAX - 1. Default to '30' if not set.

max_page_size

  • is optional

  • Type: integer

  • can be null

  • defined in: cw-storage

max_page_size Type

integer

max_page_size Constraints

minimum: the value of this number must greater than or equal to: 0

unknown format: the value of this string must follow the format: uint32