Skip to content

Split 'invalid request body or parsing failure' into three examples #200

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 21, 2022
Merged

Split 'invalid request body or parsing failure' into three examples #200

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
195142f
Split 'invalid request body or parsing failure' into three examples
benjie Jul 12, 2022
81869b3
Fix typos
benjie Jul 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 23 additions & 6 deletions spec/GraphQLOverHTTP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -537,17 +537,34 @@ The following examples provide guidance on how to deal with specific error cases
when using the `application/graphql+json` media type to encode the response
body:

##### Invalid parameters or parsing failure
##### JSON parsing failure

For example a POST response body of `NONSENSE` or `{"qeury": "{__typena`.
For example a POST request body of `NONSENSE` or `{"query":` (note: invalid
JSON).

Requests that do not constitute a well-formed GraphQL request should result in
status code `400` (Bad Request).
Requests that the server cannot interpret should result in status code `400`
(Bad Request).

##### Invalid parameters

For example a POST request body of `{"qeury": "{__typename}"}` (note: typo) or
`{"query": "query Q ($i:Int!) { q(i: $i) }", "variables": [7]}` (note: invalid
shape for `variables`).

Requests that do not constitute a well-formed _GraphQL-over-HTTP request_ should
result in status code `400` (Bad Request).

##### Document parsing failure

For example a POST response body of `{"query": "{"}`.

Requests where the _GraphQL document_ cannot be parsed should result in status
code `400` (Bad Request).

##### Document validation failure

Requests that fail to pass validation SHOULD be denied execution with a status
code of `400` (Bad Request).
Requests that fail to pass _GraphQL validation_ SHOULD be denied execution with
a status code of `400` (Bad Request).
Comment on lines +566 to +567
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This reads different from the outcome described in the other scenarios, but it really is the same? Perhaps we can describe the expected outcome once for all those failure modes - since it is the same - and only detail what the failure mode entails.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed. Is there a difference between should result in status code '400' (Bad Request). and SHOULD be denied execution with a status code of '400' (Bad Request)?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In my opinion this is concretely different from the others - you can execute this one, you cannot execute the others (because they weren't parseable so you could not determine what to execute. And so the denial of execution is what you're doing (you can't deny execution to something that you couldn't have executed in the first place).

However, "result in" would also cover it, so if you both feel strongly that wording is better/clearer I'd be happy to make the change.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can see the difference, how about a note that explains it?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure what to put in the note.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about:

Note: In this case, it would be feasible for the server to attempt execution despite validation errors.
Although generally not recommended, exceptions might be necessary to support legacy clients.


Note: In certain circumstances, for example persisted operations that were
previously known to be valid, the server MAY attempt execution regardless of
Expand Down
4 changes: 3 additions & 1 deletion spec/metadata.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@
"graphql-request": "#request",
"graphql-response": "#sec-Response",
"graphql-request-error": "#sec-Errors.Request-errors",
"graphql-field-error": "#sec-Errors.Field-errors"
"graphql-field-error": "#sec-Errors.Field-errors",
"graphql-document": "#sec-Document",
"graphql-validation": "#sec-Validation"
}
}
}