Define "execution result" and "request error result"#1159
Merged
Conversation
✅ Deploy Preview for graphql-spec-draft ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
This was referenced Apr 17, 2025
Signed-off-by: Rob Richard <[email protected]>
robrichard
force-pushed
the
robrichard/response
branch
from
f2b4d37 to
1dbb9c6
Compare
robrichard
added
the
✏️ Editorial
robrichard
commented
Apr 17, 2025
Comment on lines
+26
to
+30
| If execution raised any errors, the _execution result_ must contain an entry | ||
| with key {"errors"}. The value of this entry must be a non-empty list of | ||
| _execution error_ raised during execution. Each error must be a map as described | ||
| in the "Errors" section below. If the request completed without raising any | ||
| errors, this entry must not be present. |
Contributor
Author
There was a problem hiding this comment.
I moved and adjusted some of the text from the Errors section. Placing it under Execution Result and Request Error Result so we can describe the specific behavior (must be included in Request Error Result, may be included in Execution Result) without the Errors section having conditions for each type.
robrichard
commented
Apr 17, 2025
| If the {"data"} entry in the response is present (including if it is the value | ||
| {null}), the {"errors"} entry must be present if and only if one or more | ||
| _execution error_ was raised during execution. | ||
| The {"errors"} entry in the _execution result_ or _request error result_ is a |
Contributor
Author
There was a problem hiding this comment.
We could also define a type Response Result that includes both Execution Result and Request Error Result as subtypes, but adding another layer of hierarchy might be less clear?
benjie
requested changes
Apr 24, 2025
Member
benjie
left a comment
benjie
left a comment
There was a problem hiding this comment.
This framing feels right to me 👍
benjie
requested changes
Apr 24, 2025
fix execution Co-authored-by: Benjie <[email protected]>
benjie
approved these changes
Apr 24, 2025
benjie
approved these changes
Apr 25, 2025
benjie
approved these changes
May 22, 2025
BoD
approved these changes
Jun 5, 2025
leebyron
approved these changes
Jun 26, 2025
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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
This creates a definition for Execution Result and Request Error Result. The definition of Response is updated to include Execution Result, Request Error Result and Response Stream (for subscriptions).
Incremental Delivery will introduce additional types built on top of this change. I am currently thinking something like this: