Added more GraphQL docs to assist LLM agents. #3205
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
ma2bd
approved these changes
Jan 29, 2025
| The recipient of a transfer. | ||
|
|
||
| An example of a `Recipient`: | ||
| ```graphql |
There was a problem hiding this comment.
Technically this is json. Perhaps the comment could mention GraphQL?
| The recipient of a transfer. | ||
|
|
||
| An example of a `Recipient`: | ||
| ```graphql |
There was a problem hiding this comment.
Technically I believe this is json. Perhaps the comment could mention GraphQL?
| A non-negative amount of tokens. | ||
|
|
||
| An example of an `Amount`: | ||
| ``` |
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.
Motivation
Scalars in our codebase are not documented implicitly by GraphQL introspection.
Proposal
Add explicit documentation of the structure of some of the scalars we have.