Consistently use 'response name' not 'response key' #1147
Conversation
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
|
|
||
| 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!
mjmahone
left a comment
mjmahone
left a comment
There was a problem hiding this comment.
Personally I prefer response key but consistency is preferred to not, so not blocking.
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).