feat: add automatic pagination support to DSIS API client #29
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Qif-Equinor
reviewed
Nov 6, 2025
Qif-Equinor
reviewed
Nov 6, 2025
Qif-Equinor
reviewed
Nov 6, 2025
Collaborator
Qif-Equinor
left a comment
Qif-Equinor
left a comment
There was a problem hiding this comment.
looks good and add few comments.
could you add some tests against the new argument ?
Qif-Equinor
reviewed
Nov 7, 2025
Qif-Equinor
previously approved these changes
Nov 7, 2025
Collaborator
Qif-Equinor
left a comment
Qif-Equinor
left a comment
There was a problem hiding this comment.
please update the doc as commented.
Contributor
Author
I have updated docs to the newer version now, where we use max_pages in stead of fetch all. Not entirely sure what you mean by "Class should be used here."? , @Qif-Equinor |
Qif-Equinor
approved these changes
Nov 10, 2025
TordAreStromsnes
pushed a commit
that referenced
this pull request
Nov 10, 2025
🤖 I have created a release *beep* *boop* --- ## [0.3.0](v0.2.1...v0.3.0) (2025-11-10) ### Features * add automatic pagination support to DSIS API client ([#29](#29)) ([c4e5766](c4e5766)), closes [#28](#28) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request introduces automatic pagination support to the DSIS API client and updates the documentation to explain how pagination works and how to control it. The main logic for following OData
nextLinkreferences and aggregating paged results is now handled transparently when usingexecute_query(), with an option to disable it for manual pagination. Theget()method has also been refactored and moved to the base client class.The most important changes include:
Pagination Support and API Enhancements
execute_query()via a newfetch_allparameter (defaultTrue). When enabled, the client follows allodata.nextLinkreferences and aggregates results into a single response. Manual pagination is possible by settingfetch_all=False. The logic for aggregating paged results is implemented in the new_aggregate_nextlink_pageshelper method. [1] [2] [3]Client Refactoring
get()method fromDSISClienttoBaseClientto reduce duplication and improve maintainability. The method was also refactored for clarity and to ensure schema validation is handled in the base class. [1] [2] [3] [4]Documentation Updates
fetch_allparameter, and when to use or disable it. Added a new example demonstrating manual pagination control. [1] [2]closes #28