docs: add pagination guide#447
Open
Chrisland-ui wants to merge 1 commit into
Open
Conversation
|
@Chrisland-ui Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Create a comprehensive docs/pagination.md guide that documents how cursor-based pagination works across all supported StellarKit API endpoints. The guide should serve as a single reference for developers, explaining the purpose of cursor-based pagination, the limit and cursor query parameters, what the cursor value represents, how to request subsequent pages, and how to determine when the end of a paginated result set has been reached.
Include a complete, step-by-step example demonstrating how to paginate through all payments for an account, showing the initial request, extracting the returned cursor, requesting additional pages, and stopping when no further results are available. Link the new guide from both docs/api-design.md and the project README to improve discoverability, and ensure the documentation is accurate, consistent with the existing API behavior, and easy for developers to follow.
closes #442