Skip to content

GraphQL docs are out of date #21448

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

Open
yanganto opened this issue Mar 9, 2025 · 3 comments
Open

GraphQL docs are out of date #21448

yanganto opened this issue Mar 9, 2025 · 3 comments
Assignees
Labels
doc-issue Issue submitted using the Doc issue template

Comments

@yanganto
Copy link
Contributor

yanganto commented Mar 9, 2025

This issue is reported from a user in Taipei Hacker House.

The category of the GraphQL is updated beta and the example code is still in alpha.
https://github.com/MystenLabs/sui/blob/main/docs/content/references/sui-graphql.mdx
https://github.com/MystenLabs/sui/blob/main/docs/content/concepts/graphql-rpc.mdx

The seems the example on the web site is away from we are using here.
https://github.com/MystenLabs/ts-sdks/blob/dfc0c9b915fb2050f69b74cb6cef7f0f93570e4c/packages/graphql-transport/src/queries/getDynamicFieldObject.graphql

Besides, it will be nice to have an example to explain how we use GraphQL to handle the dynamic fields, it is hard to know how to handle dynamic fields with GraphQL from the web site.

Many thanks. 🙏

@yanganto yanganto added the doc-issue Issue submitted using the Doc issue template label Mar 9, 2025
Copy link
Contributor

github-actions bot commented Mar 9, 2025

Thank you for opening this issue, a team member will review it shortly. Until then, please do not interact with any users that claim to be from Sui support and do not click on any links!

@klren0312
Copy link
Contributor

@yanganto
Copy link
Contributor Author

The thing we are missing is how to select one of the object in the dynamic field, there are a least type and bcs need to provide in the query. What is the valid format of a type, how can we provide the bcs in the query are not show in the web page.

And it will be nice to provide an example help user to know how to obtain an a part of objects in the dynamic field or not all objects in dynamic field.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-issue Issue submitted using the Doc issue template
Projects
None yet
Development

No branches or pull requests

3 participants