Skip to content

Commit afc3ae4

Browse files
committed
adds documentation for the pagination classes
1 parent b9c70bb commit afc3ae4

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,16 @@ pip install apimatic-core
9696
| [`AnyOf`](apimatic_core/types/union_types/any_of.py ) | A class to represent information about AnyOf union types |
9797
| [`LeafType`](apimatic_core/types/union_types/leaf_type.py ) | A class to represent the case information in an OneOf or AnyOf union type |
9898

99+
## Pagination
100+
| Name | Description |
101+
|--------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
102+
| [`CursorPagination`](apimatic_core/pagination/strategies/cursor_pagination.py) | This class manages the extraction and injection of cursor values between API requests and responses, enabling seamless traversal of paginated data. It validates required pointers, updates the request builder with the appropriate cursor, and applies a metadata wrapper to paged responses. |
103+
| [`LinkPagination`](apimatic_core/pagination/strategies/link_pagination.py) | This class updates the request builder with query parameters from the next page link and applies a metadata wrapper to the paged response. |
104+
| [`OffsetPagination`](apimatic_core/pagination/strategies/offset_pagination.py) | This class manages pagination by updating an offset parameter in the request builder, allowing sequential retrieval of paginated data. It extracts and updates the offset based on a configurable JSON pointer and applies a metadata wrapper to each page response. |
105+
| [`PagePagination`](apimatic_core/pagination/strategies/page_pagination.py) | This class manages pagination by updating the request builder with the appropriate page number, using a JSON pointer to identify the pagination parameter. It also applies a metadata wrapper to each paged response, including the current page number. |
106+
| [`PaginatedData`](apimatic_core/pagination/paginated_data.py) | Provides methods to iterate over items and pages, fetch next pages using defined pagination strategies, and access the latest HTTP response and request builder. Supports independent iterators for concurrent traversals. |
107+
108+
99109
## Utilities
100110
| Name | Description |
101111
|--------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------|

0 commit comments

Comments
 (0)