Consistently use 'response name' not 'response key' #1147
+25
−24
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
benjie
added
the
✏️ Editorial
✅ Deploy Preview for graphql-spec-draft ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
benjie
changed the title
robrichard
reviewed
Mar 10, 2025
| @@ -466,8 +466,9 @@ These two operations are semantically identical: | |||
|
|
|||
| Alias : Name : | |||
|
|
|||
| By default a field's response key in the response object will use that field's | |||
| name. However, you can define a different response key by specifying an alias. | |||
| :: A _response name_ is the key in the response object which correlates with a | |||
There was a problem hiding this comment.
Thinking out loud -
Should response object be updated to response map in #1039?
But then this will not be accurate with incremental delivery, as a response name can also appear in the subsequent payloads. Should there be a new term (Response Data Tree?) to refer to the entire response data?
There was a problem hiding this comment.
I think this is referring to the object in the response representing the current Object Type's data, as opposed to the entire response which may use multiple names/aliases which may or may not overlap. It's a good point though, we should be clearer about this!
robrichard
approved these changes
Mar 10, 2025
martinbonnin
approved these changes
Mar 10, 2025
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.
Extracts the definition of "response key" from #1039, replaces occurrences of "response key" with "response name" for consistency, and links in relevant places.
Fixes #1144.
Why "response name" and not "response key"? Previously we used a mixture to mean the same thing, and GraphQL.js generally uses
responseName(responseKeyis only used in the new code relating to incremental delivery).