Add missing GraphQL argument descriptions #5547
Merged
Conversation
This file contains hidden or 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
Signed-off-by: Eric Dobbertin <[email protected]>
Signed-off-by: Eric Dobbertin <[email protected]>
von-steinkirch
approved these changes
Sep 12, 2019
Contributor
There was a problem hiding this comment.
Checked that descriptions are successfully shown in http://localhost:3000/graphql-beta
🛳-it!
Merged
Merged
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.
Impact: minor
Type: docs
Changes
In preparation for being able to generate static GraphQL API documentation, we need to ensure that all GraphQL field arguments have descriptions. This adds a GraphQL linter rule that checks for argument descriptions, and adds all missing descriptions so that the new linter rule passes.
Breaking changes
None
Testing
Verify the app starts and works, and that you can see a description for any field argument when browsing schema docs on http://localhost:3000/graphql-beta