feat: Apply in-code documentation to generated GraphQL #519
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
JairusSW
changed the title
JairusSW
changed the title
JairusSW
changed the title
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
…nctions-and-use-in-graphql
…nctions-and-use-in-graphql
…nctions-and-use-in-graphql
…nctions-and-use-in-graphql
mattjohnsonpint
changed the title
jairad26
approved these changes
Nov 23, 2024
JairusSW
deleted the
jairus/hyp-2411-extract-doc-comments-from-functions-and-use-in-graphql
branch
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.
If functions and types are decorated with doc comments (ie. JSDoc for AssemblyScript, GoDoc for Go), then we should be able to have the SDK extract the comments during the build, sanitize them to a common format, and include them in the metadata.
These can then be used during GraphQL schema generation to document the generated API, which should be visible from tools like GraphiQL and Postman.