Queries¶
The library provide some useful tooling for creating dataclasses for validating schema when querying paginated endpoints.
Pagination¶
Base class¶
Paginated Data¶
- class openapi.pagination.PaginatedData(url: yarl.URL, data: list, pagination: openapi.pagination.pagination.Pagination, total: Optional[int] = None)[source]¶
Named tuple containing paginated data and methods for retrieving links to previous or next data in the pagination
- pagination: openapi.pagination.pagination.Pagination¶
Pagination dataclass which created the data
- url: yarl.URL¶
Base url
Visitor¶
Limit/Offset Pagination¶
- openapi.pagination.offsetPagination(*order_by_fields, default_limit=50, max_limit=100)[source]¶
Crate a limit/offset
Pagination
dataclass- Return type
Cursor Pagination¶
searchable¶
- openapi.pagination.searchable(*searchable_fields)[source]¶
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