Skip to content

Commit 241abdc

Browse files
benjieghmcadamsspawnia
authored
Rework specification with a focus on backwards compatibility (#175)
* Start editing spec * GraphQL server -> server; GraphQL client -> client * Content-Types * Request edits * Rework Content-Types and start work on Response * Status codes differ between media types * Special case for data:null * Update wording around status codes * Revisions from second read-through * Another editing pass * Update spec/GraphQLOverHTTP.md * Apply suggestions from code review Co-authored-by: Gabriel McAdams <[email protected]> * Clarify server parsing (suggestion by @ghmcadams) * Move media type rules to media type section * Prettier * Move 'JSON Encoding' section into POST section * 'X in the GraphQL specification' -> 'GraphQL's X' * -we * Correct typo * Add @ghmcadams' suggestions (modified) * Reword * Apply @spawnia's improvement Co-authored-by: Benedikt Franke <[email protected]> * You must assume UTF-8 (thanks @spawnia) Co-authored-by: Benedikt Franke <[email protected]> * Client MUST indicate Content-Type - thanks @michaelstaib * Make it clearer we're referring to a term * Prettier * Grammar (thanks @spawnia) Co-authored-by: Benedikt Franke <[email protected]> * Fix the formatting of POST example * Clarify non-normative note about authorization decisions * Clarification around client Accept header * Consistently format variables * Remove 'application/graphql+json' as encoding of request body * Move the "AS IS" fullstop to match GraphQL spec Co-authored-by: Benedikt Franke <[email protected]> * Grammar (thanks @ghmcadams) Co-authored-by: Gabriel McAdams <[email protected]> Co-authored-by: Benedikt Franke <[email protected]>
1 parent f00f727 commit 241abdc

File tree

3 files changed

+429
-164
lines changed

3 files changed

+429
-164
lines changed

INTERESTED_DEVELOPERS.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ involved with the following steps:
1111
GraphQL-over-HTTP working group. Given our world-wide span over many
1212
timezones, we are doing an experiment of attempting to advance the spec with
1313
fewer meetings and more asynchronous communication. During this experiment,
14-
please reach out over slack and github.
14+
please reach out over Discord and GitHub.
1515
3. Add yourself to `List of Developers` below.
1616
4. Find our working group on the
17-
[GraphQL Foundation slack community](https://slack.graphql.org) in the
18-
[graphql-over-http channel](https://graphql.slack.com/archives/CRTKLUZRT).
17+
[GraphQL Foundation Discord community](https://discord.graphql.org) in the
18+
#graphql-over-http channel.
1919

2020
## List of Developers
2121

ROADMAP.md

+12-5
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,18 @@ client and server are compliant._
1515

1616
## Version 1.0
1717

18-
After significant meetings, the Working Group has come to consensus that a first
19-
version of this spec should introduce some key changes over the prior existing
20-
uses of GraphQL over HTTP. This first version _might_ also codify existing prior
21-
common usages of GraphQL over HTTP. In layout and structure version 1.0 should
22-
lay a foundation for future development and standardization.
18+
Version 1 aims to codify the most common existing uses of GraphQL queries and
19+
mutations over HTTP whilst encouraging some improved practices. The majority of
20+
GraphQL servers should find that they are already compatible with Version 1.0 of
21+
the GraphQL-over-HTTP specification, although they should still put work in to
22+
address the `SHOULD` behaviours that they may be missing, most notably around
23+
the use of the `application/graphql+json` Content-Type.
24+
25+
Subscriptions, websockets and server-sent events are out of scope for version
26+
1.0.
27+
28+
In layout and structure version 1.0 should lay a foundation for future
29+
development and standardization.
2330

2431
### Scope
2532

0 commit comments

Comments
 (0)