Offset-based pagination schema.

Hierarchy

  • StatusPagesPagination

Constructors

Properties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any
firstOffset?: number

Integer representing the offset to fetch the first page of results.

lastOffset?: number

Integer representing the offset to fetch the last page of results.

limit?: number

Integer representing the number of elements to returned in the results.

nextOffset?: number

Integer representing the index of the first element in the next page of results. Equal to page size added to the current offset.

offset?: number

Integer representing the index of the first element in the results.

prevOffset?: number

Integer representing the index of the first element in the previous page of results.

total?: number

Integer representing the total number of elements available.

Generated using TypeDoc