Skip to content
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

Incorrect Docs Regarding GraphQL Status Codes #362

Open
1 task done
cbhdalton opened this issue Sep 27, 2024 · 0 comments
Open
1 task done

Incorrect Docs Regarding GraphQL Status Codes #362

cbhdalton opened this issue Sep 27, 2024 · 0 comments

Comments

@cbhdalton
Copy link

Is there an existing issue for this?

  • I have searched the existing issues

Which topic?

https://github.com/AdobeDocs/commerce-webapi/blob/main/src/pages/graphql/usage/api-response.md

What's wrong with the content?

The docs talk about GraphQL responses giving standard HTTP response codes (200, 401, 403, and 500) on queries, but I don't believe that's correct. Unless I'm missing something, Magento and Adobe Commerce always return a 200 status code for anything processed by GraphQL, or a 500 error if something wrong happened in the transport layer or if the request was malformed (e.x. missing a bracket in the body).

Even following the example given in the documentation -- querying customer info without a valid token -- returns a 200 when I test it, not the 401 that the docs say it should.

What changes do you propose?

Remove references to the 401 and 403 status codes from the documentation, or if there are queries that do result in non-200 or 500 error codes, update the docs with those examples instead.

Anything else that can help to cover this?

No response

@github-project-automation github-project-automation bot moved this to 🆕 Ready for Grooming in Commerce - Issues Sep 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🆕 Ready for Grooming
Development

No branches or pull requests

1 participant