Skip to content

Commit 5ad9083

Browse files
authored
Merge pull request #18 from mkantor/patch-1
Fix a few typos in graphql.md.
2 parents b230d4e + 17b9a96 commit 5ad9083

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/graphql.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ Several API formats and architecture including [GraphQL](https://graphql.org/),
44

55
By using HTTP/2 Server Push, Vulcain fixes most problems caused by compound documents and sparse fieldsets based formats such as GraphQL and JSON:API:
66

7-
* Because each pushed resource is sent in a separate HTTP/2 stream (HTTP/2 multiplexing), related resources can be sent in parallel to the client thanks
8-
* While embedding resources is a forced push (the client receive the full JSON documents, even if it already has some parts of it), HTTP/2 Server Push allows the client [to cancel the push of resources it already has](cache.md), saving bandwidth and improving performance
9-
* Consequently, clients and network intermediates (such as [Varnish cache](cache.md)), can store each resource in a specific cache, while resource embedding only allows to have the full big JSON document in cache, [cache invalidation](https://en.wikipedia.org/wiki/Cache_invalidation) is then more efficient with Vulcain, and can be done at the HTTP level
7+
* Because each pushed resource is sent in a separate HTTP/2 stream (HTTP/2 multiplexing), related resources can be sent in parallel to the client.
8+
* While embedding resources is a forced push (the client receive the full JSON documents, even if it already has some parts of it), HTTP/2 Server Push allows the client [to cancel the push of resources it already has](cache.md), saving bandwidth and improving performance.
9+
* Consequently, clients and network intermediates (such as [Varnish cache](cache.md)), can store each resource in a specific cache, while resource embedding only allows to have the full big JSON document in cache, [cache invalidation](https://en.wikipedia.org/wiki/Cache_invalidation) is then more efficient with Vulcain, and can be done at the HTTP level.
1010

11-
Specifically with GraphQL, using cache mechanisms provided by the HTTP protocol isn't easy (`POST` request cannot be cached)
11+
Specifically with GraphQL, using cache mechanisms provided by the HTTP protocol isn't easy (`POST` requests cannot be cached).
1212

1313
## Using GraphQL as Query Language for Vulcain
1414

@@ -22,11 +22,11 @@ Thanks to `apollo-link-rest` you can write your request in GraphQL, use all [the
2222

2323
This approach also fixes [all the problems coming with using GraphQL server-side](https://dunglas.fr/2018/03/symfonylive-paris-slides-rest-vs-graphql-illustrated-examples-with-the-api-platform-framework/)!
2424

25-
Note: a higer-level library dedicated to Vulcain is being written.
25+
Note: a higher-level library dedicated to Vulcain is being written.
2626

2727
## Type System and Introspection
2828

29-
Vulcains focuses on solving the under-fetching and the over-fetching problems. It's out of Vulcain's scope to provide a type system and an introspection mechanism.
29+
Vulcain focuses on solving the under-fetching and the over-fetching problems. It's out of Vulcain's scope to provide a type system and an introspection mechanism.
3030
However, Vulcain has been designed to play very well with existing formats providing these capabilities.
3131

3232
For hypermedia APIs, we strongly recommend to use [W3C's JSON-LD](https://json-ld.org/spec/latest/json-ld-api-best-practices/) along with [the Hydra Core Vocabulary](http://www.hydra-cg.com/). For less advanced non-hypermedia APIs, we recommend [OpenAPI](https://www.openapis.org/) (formerly known as Swagger).

0 commit comments

Comments
 (0)