Adds descriptions to @requireAuth @skipAuth directives and its generator templates #3435
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
dthyresson
changed the title
thedavidprice
approved these changes
Sep 28, 2021
There was a problem hiding this comment.
GTG
@dthyresson please loop in @dac09 if still required. Otherwise please merge and I'll add to RC branch.
dac09
approved these changes
Sep 28, 2021
thedavidprice
added a commit
that referenced
this pull request
Sep 29, 2021
Co-authored-by: David Price <thedavid@thedavidprice.com>
dac09
added a commit
that referenced
this pull request
Sep 29, 2021
…rl-config * 'main' of github.com:redwoodjs/redwood: Add core-js to codemods dep for polyfills (#3448) add missing prepublish script (#3445) add missing deps (#3444) Remove codemods dependency on @redwoodjs/internal (#3443) Revert "add missing dep (#3441)" (#3442) add missing dep (#3441) Add @redwoodjs/codemods (#3411) Fix gitpod port forwarding (#3434) Re-vamp Redwood splash-page (#3183) Adds comments to directives and its templates (#3435) Readme updates to introduction technologies for GraphQL (#3433)
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.
Descriptions help document the GraphQL schema.
This PR adds comments to the built-in @requireAtuh and @skipAuth directives and also adds some boilerplate that can be edited for custom validator and transformer templates.
These use
string literalsie (""").You can see the descriptions when introspecting the schema docs, seen here:
Note: Similar descriptions could be added to
FYI: Descriptions like these appear in the schema. A comment (
#) is a comment, but not shared when introspecting the schema.