Trying to improve doc. of execution-pipline.md by correcting and... #497
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
xperiandri
reviewed
Sep 23, 2024
|
|
||
| As result of GraphQL query execution, a dictionary with resolved values will be returned. It contains following fields: | ||
| The result of a GraphQL query execution is a dictionary with resolved values. This dictionary contains the following fields: |
There was a problem hiding this comment.
Actually, now it is a GQLResponse object
type GQLResponse =
{ DocumentId: int
Data : Output Skippable
Errors : GQLProblemDetails list Skippable }There was a problem hiding this comment.
Suggested change
| The result of a GraphQL query execution is a dictionary with resolved values. This dictionary contains the following fields: | |
| The result of a GraphQL query execution is a `GQLResponse` object with the following fields: |
Comment on lines
+55
to
+57
| - `documentId`: which is the hash code of the query's AST document - it can be used to implement execution plan caching (persistent queries). | ||
| - `data`: with a formated GraphQL response matching the requested query. | ||
| - `errors`: optional. If it has been provided, it will contain a list of errors that occured during query execution. |
There was a problem hiding this comment.
Suggested change
| - `documentId`: which is the hash code of the query's AST document - it can be used to implement execution plan caching (persistent queries). | |
| - `data`: with a formated GraphQL response matching the requested query. | |
| - `errors`: optional. If it has been provided, it will contain a list of errors that occured during query execution. | |
| - `documentId`: which is the hash code of the query's AST document - it can be used to implement execution plan caching (persistent queries). | |
| - `data`: optional, a formatted GraphQL response matching the requested query (`KeyValuePair seq`). Absent in case of an error that does not allow continuing processing and returning any GraphQL results. | |
| - `errors`: optional, contains a list of errors (`GQLProblemDetails`) that occurred during query execution. |
xperiandri
force-pushed
the
dev
branch
5 times, most recently
from
d90f0e9
to
434b4be
Compare
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.
rephrasing.