From 8b88d653f12a53bcd7649f846f440eb7a6de007a Mon Sep 17 00:00:00 2001 From: Sultan Iman Date: Wed, 22 May 2024 12:27:51 +0200 Subject: [PATCH] Add new section about incremental loading --- docs/website/docs/general-usage/http/rest-client.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/website/docs/general-usage/http/rest-client.md b/docs/website/docs/general-usage/http/rest-client.md index 8c2317f6f9..f6ea552614 100644 --- a/docs/website/docs/general-usage/http/rest-client.md +++ b/docs/website/docs/general-usage/http/rest-client.md @@ -536,6 +536,10 @@ def custom_response_handler(response): client.paginate("/posts", hooks={"response": [custom_response_handler]}) ``` +### Incremental loading + +TODO + The handler function may raise `IgnoreResponseException` to exit the pagination loop early. This is useful for the enpoints that return a 404 status code when there are no items to paginate. ## Shortcut for paginating API responses