Skip to content

docs: add guide on graphql-http errors #2006

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

Open
wants to merge 12 commits into
base: source
Choose a base branch
from

Conversation

sarahxsanders
Copy link
Contributor

Description

  • Adds guide on graphql-http errors (just some common ones) and how to debug them
  • Adds block on Best Practices landing page

Feel free to suggest additional common errors if there are any that might be important to highlight here!

Copy link

vercel bot commented May 30, 2025

@sarahxsanders is attempting to deploy a commit to the The GraphQL Foundation Team on Vercel.

A member of the Team first needs to authorize it.

@sarahxsanders sarahxsanders marked this pull request as ready for review May 30, 2025 18:22
@saihaj saihaj requested a review from enisdenjo June 2, 2025 14:24
Copy link
Member

@benjie benjie left a comment

Choose a reason for hiding this comment

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

This is really good general reference that should be applicable to any server implementing GraphQL-over-HTTP (not just the reference implementation).

One concern is it does not incorporate the application/graphql-response+json media type. Since the spec is currently a draft I wouldn't normally be too concerned, except we do link to the spec so we should recommend its recommendations.

Copy link

vercel bot commented Jun 7, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
graphql-github-io ❌ Failed (Inspect) Jun 7, 2025 4:57am

@sarahxsanders sarahxsanders requested a review from benjie June 9, 2025 23:29
@sarahxsanders
Copy link
Contributor Author

This is really good general reference that should be applicable to any server implementing GraphQL-over-HTTP (not just the reference implementation).

One concern is it does not incorporate the application/graphql-response+json media type. Since the spec is currently a draft I wouldn't normally be too concerned, except we do link to the spec so we should recommend its recommendations.

added a section about understanding response formats, I hope that addresses this better!

Copy link
Member

@enisdenjo enisdenjo left a comment

Choose a reason for hiding this comment

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

Are we sure about the 415 and 422? The spec itself does not recommend them, it's up to the implementor to choose using it and follow HTTP conventions.

@sarahxsanders
Copy link
Contributor Author

@enisdenjo I removed those sections and added a section w/ a disclaimer, let me know if this addresses that!

@sarahxsanders sarahxsanders requested a review from enisdenjo June 10, 2025 23:58
@enisdenjo
Copy link
Member

It's looking good now, thanks!

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