Skip to content

docs: examples of things only GraphQL can do#19668

Merged
amnn merged 1 commit into
mainfrom
amnn/docs-gql-eg
Oct 2, 2024
Merged

docs: examples of things only GraphQL can do#19668
amnn merged 1 commit into
mainfrom
amnn/docs-gql-eg

Conversation

@amnn

@amnn amnn commented Oct 2, 2024

Copy link
Copy Markdown
Contributor

Description

Adding some examples of things that we can do with GraphQL that can't be done with JSON-RPC.

Test plan

👀 (and trying out the queries)


Release notes

Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required.

For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates.

  • Protocol:
  • Nodes (Validators and Full nodes):
  • Indexer:
  • JSON-RPC:
  • GraphQL:
  • CLI:
  • Rust SDK:
  • REST API:

## Description

Adding some examples of things that we can do with GraphQL that can't be done with JSON-RPC.

## Test plan

:eyes: (and trying out the queries)
@amnn amnn self-assigned this Oct 2, 2024
@vercel

vercel Bot commented Oct 2, 2024

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sui-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 2, 2024 9:17pm
3 Skipped Deployments
Name Status Preview Comments Updated (UTC)
multisig-toolkit ⬜️ Ignored (Inspect) Oct 2, 2024 9:17pm
sui-kiosk ⬜️ Ignored (Inspect) Oct 2, 2024 9:17pm
sui-typescript-docs ⬜️ Ignored (Inspect) Oct 2, 2024 9:17pm

@stefan-mysten stefan-mysten left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent, thanks for improving the docs!

@amnn amnn merged commit b7dab06 into main Oct 2, 2024
@amnn amnn deleted the amnn/docs-gql-eg branch October 2, 2024 21:29
@longbowlu

Copy link
Copy Markdown
Contributor

thanks @amnn ! just saw this.
Since these are features that are not feasible in json-rpc, should this be included in the general graphql reference doc, instead of the "migration" one?

@amnn

amnn commented Oct 6, 2024

Copy link
Copy Markdown
Contributor Author

When GraphQL is productionised we will flesh out the examples that demonstrate what it can do, and we can split this out at that point. We don't want to do that just yet because we don't want to encourage people to rely on GraphQL before the infra has stabilised and before we have third party providers running the service.

The APIs that show up in the examples are already documented in the Reference section.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Type: Documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants