Queries

The library provide some useful tooling for creating dataclasses for validating schema when querying paginated endpoints.

Pagination

Base class

class openapi.pagination.Pagination

Base class for Pagination

apply(visitor)

Apply pagination to the visitor

Return type

None

links(url, data, total=None)

Return links for paginated data

Return type

Dict[str, str]

paginated(url, data, total=None)

Return paginated data

Return type

PaginatedData

Paginated Data

class openapi.pagination.PaginatedData(url: yarl.URL, data: list, pagination: openapi.pagination.pagination.Pagination, total: Optional[int] = None)

Named tuple containing paginated data and methods for retrieving links to previous or next data in the pagination

data: list

Paginated list of data

header_links()

Header links

Return type

str

json_response(headers=None, **kwargs)

Create a JSON response with link header

pagination: openapi.pagination.pagination.Pagination

Pagination dataclass which created the data

total: Optional[int]

Total number of records (supported by limit/offset pagination only)

url: yarl.URL

Base url

Visitor

class openapi.pagination.PaginationVisitor

Visitor for pagination

apply_cursor_pagination(cursor, limit, order_by, previous)

Apply cursor pagination

apply_offset_pagination(limit, offset, order_by)

Apply limit/offset pagination

Limit/Offset Pagination

openapi.pagination.offsetPagination(*order_by_fields, default_limit=50, max_limit=100)

Crate a limit/offset Pagination dataclass

Return type

Type[Pagination]

Cursor Pagination

openapi.pagination.cursorPagination(*order_by_fields, default_limit=50, max_limit=100)

Return type

Type[Pagination]

searchable

openapi.pagination.searchable(*searchable_fields)

Create a dataclass with search_fields class attribute and search field. The search field is a set of field which can be used for searching and it is used internally by the library, while the search field is the query string passed in the url.

Parameters

searchable_fields – fields which can be used for searching

Return type

type