-
Notifications
You must be signed in to change notification settings - Fork 168
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[SDK 2665] Update endpoint methods to support 'from' and 'take' checkpoint pagination parameters, where appropriate #278
Conversation
… pagination parameters, where appropriate
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm seeing now that page/per_page
could mean the same as from/take
. Have you tried what happens if a call that was using the former now uses the latter? Because if that's the case, all these methods could be simplified in either of these two ways:
- duplicated method signatures, each using its variant.
- keep the old signature, but when building the request, mapping the old variant to the new one.
Might be worth checking with the team if the old properties are deprecated now that the endpoint supports "checkpoint" pagination.
Co-authored-by: Luciano Balmaceda <[email protected]>
Hey @lbalmaceda 👋 Thanks, I've merged those suggestions.
It's true This isn't something that could be mapped in the way suggested, unfortunately. As far as splitting up the endpoint methods for checkpoint pagination variants, we can certainly do that. Personally, this feels like something that should just be handled with method arguments to me — but I'm happy to implement this however you think best suits the SDK.
Checkpoint pagination always takes precedence by the API in handling requests; it falls back to basic pagination when
No indication from anyone I've spoken with that basic pagination is going anywhere. Checkpoint pagination just addresses the problem of API dataset changes being applied between client API requests, causing a shift in results, which can lead to gaps in data on the client's end. |
Changes
This PR updates the following methods to support checkpoint pagination API2 parameters:
Roles::list_users()
Organizations::all_organizations()
Organizations::all_organization_members()
References
Testing
Checklist