Skip to content

docs: add comprehensive cursor-based pagination guide and endpoint registry#184

Merged
Sulex45 merged 2 commits into
stellarkit-lab-devtools:mainfrom
Adedayo-Data:docs/cursor-pagination-guide
May 29, 2026
Merged

docs: add comprehensive cursor-based pagination guide and endpoint registry#184
Sulex45 merged 2 commits into
stellarkit-lab-devtools:mainfrom
Adedayo-Data:docs/cursor-pagination-guide

Conversation

@Adedayo-Data
Copy link
Copy Markdown

Description

Augments the repository documentation by adding an explicit, step-by-step Pagination Guide. This ensures developer integration workflows handle large list datasets efficiently using uniform, cursor-based navigation patterns.

Changes Implemented

  • Pagination Guide Section: Detailed the operational parameters (limit, order, and cursor) that govern list evaluation endpoints.
  • Cursor Mechanics Walkthrough: Provided an explicit operational breakdown explaining how to extract the nextCursor string attribute from a response metadata payload and feed it into subsequent request parameters.
  • Structural Request/Response Example: Illustrated matching JSON envelope schemas for both the initial page execution and the subsequent cursor-driven page transition.
  • Paginated Endpoint Registry: Cataloged all active endpoints currently enforcing cursor-based pagination structures:
    • GET /transactions/:id
    • GET /transactions/:id/operations
    • GET /account/:id/payments
    • GET /account/:id/timeline
    • GET /account/:id/transactions/search
    • GET /asset/:code/:issuer/holders

Verification Plan

@drips-wave
Copy link
Copy Markdown

drips-wave Bot commented May 29, 2026

@Adedayo-Data 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! 🚀

Learn more about application limits

@Sulex45 Sulex45 merged commit bdabb63 into stellarkit-lab-devtools:main May 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Pagination Guide for All Paginated Endpoints in README

2 participants