Editorial: move "Path" to it's own section #1129
Open
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
✅ Deploy Preview for graphql-spec-draft ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
benjie
reviewed
Dec 5, 2024
|
@benjie thanks for the feedback! I have applied your suggestions. |
robrichard
force-pushed
the
robrichard/error-path
branch
from
f9c4359 to
2087016
Compare
benjie
requested changes
Jan 9, 2025
| the path to the error must use the aliased name, since it represents a path in | ||
| the response, not in the request. | ||
| `null` result is intentional or caused by a runtime error. The value of this | ||
| entry is described in the [Path](#sec-Path) section. |
There was a problem hiding this comment.
Suggested change
| entry is described in the [Path](#sec-Path) section. | |
| _path entry_ is described in the [Path](#sec-Path) section. |
Comment on lines
+243
to
+249
| :: A _path entry_ allows for the association with a particular field reached | ||
| during GraphQL execution. The value for this entry must be a list of path | ||
| segments starting at the root of the response and ending with the field to be | ||
| associated with. Path segments that represent fields must be strings, and path | ||
| segments that represent list indices must be 0-indexed integers. If a path | ||
| segment is associated with an aliased field it must use the aliased name, since | ||
| it represents a path in the response, not in the request. |
There was a problem hiding this comment.
Suggested change
| :: A _path entry_ allows for the association with a particular field reached | |
| during GraphQL execution. The value for this entry must be a list of path | |
| segments starting at the root of the response and ending with the field to be | |
| associated with. Path segments that represent fields must be strings, and path | |
| segments that represent list indices must be 0-indexed integers. If a path | |
| segment is associated with an aliased field it must use the aliased name, since | |
| it represents a path in the response, not in the request. | |
| :: A _path entry_ is an entry within an _error result_ that allows for | |
| association with a particular field reached during GraphQL execution. | |
| The value for a _path entry_ must be a list of path segments starting at the | |
| root of the response and ending with the field to be associated with. Path | |
| segments that represent fields must be strings, and path segments that represent | |
| list indices must be 0-indexed integers. If a path segment is associated with an | |
| aliased field it must use the aliased name, since it represents a path in the | |
| response, not in the request. |
I tried to make this independent of error but I was just not happy with how it read. When you integrate this into the stream/defer work, you can change just the definition, e.g. something like:
:: A _path entry_ is an entry within a _request error_ or _incremental payload_
that allows for association with a particular field reached during GraphQL
execution.
Comment on lines
+251
to
+252
| When the _path entry_ is present on an "Error result", it identifies the | ||
| response field which experienced the error. |
There was a problem hiding this comment.
Suggested change
| When the _path entry_ is present on an "Error result", it identifies the | |
| response field which experienced the error. | |
| When the _path entry_ is present on an _error result_, it identifies the | |
| response field which experienced the error. |
This references a definition that doesn't yet exist, but that's okay... We can create it later.
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.
Extracted from the
@defer/@streamspec edits (#1110) to minimize the diff there.Since the incremental delivery response format also uses
Path, I removed it from the Errors section and into it's own section.