[GraphQL/Docs] Documenting Connections, Cursors, Pagination etc. #16020
Conversation
This file contains 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
Create distinct top-level headings under "References" for "Sui JSON-RPC API" and "Sui GraphQL API". This was to avoid a couple of confusing aspects of the previous IA: - It was unclear when reading "Sui API" what that was referring to (GraphQL or JSON-RPC). - The "RPC Best Practices" page (intended for JSON-RPC) was confusingly next to the GraphQL references. Test Plan: ``` docs/site$ pnpm build && pnpm start ``` + 👀
Adding documentation on how Connections work, including cursors, consistency, available range, page limits, and some examples of forward and backward pagination. Test Plan: ``` docs/site$ pnpm build && pnpm start ```
amnn
requested review from
emmazzz,
ronny-mysten,
suiwombat,
wlmyng,
stefan-mysten and
a team
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
github-actions
bot
added
the
Type: Documentation
stefan-mysten
approved these changes
Jan 31, 2024
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.
Description
Adding documentation on how Connections work, including cursors, consistency, available range, page limits, and some examples of forward and backward pagination.
Test Plan
Stack