Clarify viewer, mention node field
#20
Merged
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
We've seen a fair number of people mistakenly put *all* of their fields under `viewer`, even when they don't need to. This leads to patterns where the route has just `viewer`, and then the container has something like `fragment on Viewer { node(id: $id) }` - super confusing and totally unnecessary, since you can do `query { node(id: $id) }`.
|
The actual language itself here is just a rough draft; more important is to correct the information and ensure that users understand when to use viewer and when to use node. |
Merged
|
This a very good point @josephsavona. I think we should even be a bit more explicit and verbose about this as in fact most APIs get that (unintentionally) wrong. @marktani would you mind merging that in and extending this second to reflect @josephsavona's thoughts? Also, see #20 for this. |
marktani
approved these changes
Sep 19, 2016
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.
We've seen a fair number of people mistakenly put all of their fields under
viewer, even when they don't need to. This leads to patterns where the route has justviewer, and then the container has something likefragment on Viewer { node(id: $id) }- super confusing and totally unnecessary, since you can doquery { node(id: $id) }.