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

Remove watershed and prefer new format #330

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

Remove watershed and prefer new format #330

wants to merge 4 commits into from

Conversation

benjie
Copy link
Member

@benjie benjie commented Feb 13, 2025

This is an alternative fix to #327 and #322 that does away with the watershed entirely. I'm coming to believe the watershed was a mistake.

We:

  1. Require that compliant clients supply an Accept header (whilst noting that servers may support non-compliant clients).
  2. Require that compliant clients include application/graphql-response+json in their Accept header
  3. Name any server that only supports application/json a "legacy server"
  4. Recommend that all new servers support application/graphql-response+json
  5. Recommend that servers support application/json if and only if they want to support legacy (now non-compliant) clients

It is currently a draft because I've not had time to fully vet it, just wanted to get my thoughts down - I wouldn't review the specific wording too deeply yet.

Copy link
Contributor

@Shane32 Shane32 left a comment

Choose a reason for hiding this comment

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

This looks good to me.

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.

I like!

Co-authored-by: Shane Krueger <[email protected]>
@martinbonnin
Copy link
Contributor

Can we merge this one? I'd like to propose other changes but I'd rather not open too many PRs in parallel.

@benjie
Copy link
Member Author

benjie commented Feb 28, 2025

I hacked it out quite quickly and didn't have time to proof-read it, I'm not sure it's currently consistent?

@martinbonnin
Copy link
Contributor

LGTM. I find that it improves the readability of the spec compared to the current state and I'd be in favor of merging it.

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.

4 participants