Editorial: Define _response payload_ #1149
Open
+62
−59
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.
Follow up from #1135, Based on top of #1148
Alternative name
Response Map
: #1143This creates a definition for Response Payload, defined as the map normally returned by GraphQL queries and mutations containing data and/or errors.
The definition of Response is updated to include both Response Payload, and Response Stream (for subscriptions).
I like using
Payload
as i think it extends naturally for incremental delivery. If this change is approved I plan to add two additional types,InitialResponsePayload
andSubsequentResponsePayload
as well asIncrementalStream
, the stream of those types.Proposal for incremental delivery (roughly):
I went through every mention of response and most of the remaining usages are around response key or response field, referring to the object property name (ie for aliases and error paths). This could also likely be standardized in a follow up.See https://github.com/graphql/graphql-spec/pull/1147/files