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.

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

Conversation

benjie
Copy link
Member

@benjie benjie commented Jul 12, 2022

Following @glasser's feedback here #175 (comment) I've split the "Invalid request body or parsing failure" example into three separate examples, and added spec-md references.

I believe this change does not include any normative changes, it's purely editorial.

Incidentally these H5's are horrible:

https://graphql.github.io/graphql-over-http/draft/#sec-Operation-cannot-be-determined

6.4.2.1.3 Operation cannot be determined

We should probably hoist to a higher level somewhere? (In a separate PR.)

Comment on lines +566 to +567
Requests that fail to pass _GraphQL validation_ SHOULD be denied execution with
a status code of `400` (Bad Request).
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.

Comment on lines +566 to +567
Requests that fail to pass _GraphQL validation_ SHOULD be denied execution with
a status code of `400` (Bad Request).
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)?

Co-authored-by: Gabriel McAdams <[email protected]>
@benjie
Copy link
Member Author

benjie commented Jul 15, 2022

Suggest we merge this and @spawnia follow up with a note PR?

@spawnia
Copy link
Member

spawnia commented Jul 15, 2022

Suggest we merge this and @spawnia follow up with a note PR?

I was in the process of typing up a suggestion for a note right before you asked this 🤯

@benjie benjie merged commit cabdc15 into main Jul 21, 2022
@benjie benjie deleted the invalid-parameters-parsing-failure branch August 16, 2022 10:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants