Skip to content

Commit cb364ef

Browse files
committed
PR feedback
1 parent aa9c21c commit cb364ef

File tree

2 files changed

+15
-19
lines changed

2 files changed

+15
-19
lines changed

spec/Section 3 -- Type System.md

+3-7
Original file line numberDiff line numberDiff line change
@@ -2206,7 +2206,7 @@ fragment someFragment on User {
22062206
#### @defer Arguments
22072207

22082208
- `if: Boolean! = true` - When `true`, fragment _should_ be deferred (see
2209-
related note below). When `false`, fragment will not be deferred. Defaults to
2209+
related note below). When `false`, fragment must not be deferred. Defaults to
22102210
`true` when omitted.
22112211
- `label: String` - An optional string literal (variables are disallowed) used
22122212
by GraphQL clients to identify data from responses and associate it with the
@@ -2232,10 +2232,6 @@ additional list items in subsequent responses.
22322232

22332233
The `@include` and `@skip` directives take precedence over `@stream`.
22342234

2235-
Note: The [Directives Are Defined](#sec-Directives-Are-Defined) validation rule
2236-
ensures that GraphQL Operations containing the `@stream` directive cannot be
2237-
executed by a GraphQL service that does not support this directive.
2238-
22392235
```graphql example
22402236
query myQuery($shouldStream: Boolean! = true) {
22412237
user {
@@ -2252,8 +2248,8 @@ query myQuery($shouldStream: Boolean! = true) {
22522248
#### @stream Arguments
22532249

22542250
- `if: Boolean! = true` - When `true`, field _should_ be streamed (see related
2255-
note below). When `false`, the field will not be streamed and all list items
2256-
will be initially included. Defaults to `true` when omitted.
2251+
note below). When `false`, the field must not be streamed and all list items
2252+
must be initially included. Defaults to `true` when omitted.
22572253
- `label: String` - An optional string literal (variables are disallowed) used
22582254
by GraphQL clients to identify data from responses and associate it with the
22592255
corresponding stream directive. If provided, the GraphQL service must include

spec/Section 7 -- Response.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -326,8 +326,8 @@ field that is not known to be complete. Clients should expect the GraphQL
326326
Service to incrementally deliver the remainder of indicated list field. When the
327327
Pending Result is associated with a `@defer` directive, it indicates that the
328328
response fields contained in the deferred fragment are not known to be complete.
329-
Clients should expect the the GraphQL Service to incrementally deliver the
330-
remainder of the fields contained in the deferred fragment.
329+
Clients should expect the GraphQL Service to incrementally deliver the remainder
330+
of the fields contained in the deferred fragment.
331331

332332
If the associated `@defer` or `@stream` directive contains a `label` argument,
333333
the Pending Result must contain an entry `label` with the value of this
@@ -370,9 +370,9 @@ An Incremental List Result's `id` entry must match the `id` that was returned in
370370
a prior Pending Result. This Pending Result must be associated with a `@stream`
371371
directive.
372372

373-
The Incremental List Result's `path` can be determined using the prior Pending
373+
The Incremental List Result's path can be determined using the prior Pending
374374
Result with the same `id` as this Incremental Result. The Incremental List
375-
Result's `path` is the same as the Pending Result's `path`.
375+
Result's path is the same as the Pending Result's `path`.
376376

377377
Every Incremental List Result must contain an `items` entry. The `items` entry
378378
must contain a list of additional list items for the response field at the
@@ -393,27 +393,27 @@ the "Errors" section.
393393

394394
**Incremental Object Result Format**
395395

396-
An Incremental List Result's `id` entry must match the `id` that was returned in
397-
a prior Pending Result. This Pending Result must be associated with a `@defer`
398-
directive.
396+
An Incremental Object Result's `id` entry must match the `id` that was returned
397+
in a prior Pending Result. This Pending Result must be associated with a
398+
`@defer` directive.
399399

400-
The Incremental Object Result's `path` can be determined using the prior Pending
400+
The Incremental Object Result's path can be determined using the prior Pending
401401
Result with the same `id` as this Incremental Result. The Incremental Object
402402
Result may contain a `subPath` entry. If the `subPath` entry is present, The
403-
Incremental Object Record's path can be determined by concatenating the Pending
403+
Incremental Object Result's path can be determined by concatenating the Pending
404404
Result's `path` with this `subPath`. If no `subPath` entry is present, the path
405405
is the same as the Pending Result's `path`.
406406

407-
Every Incremental Object Result must contain an `data` entry. The `data` entry
407+
Every Incremental Object Result must contain a `data` entry. The `data` entry
408408
must contain a map of additional response fields. The `data` entry in an
409409
Incremental Object Result will be of the type of a particular field in the
410-
GraphQL result. The Incremental Object Result's `path` will contain the path
410+
GraphQL result. The Incremental Object Result's path will contain the path
411411
segments of the field this data is associated with.
412412

413413
An Incremental Object Result's data may contain response fields that were
414414
contained in more than one deferred fragments. In that case, the `id` of the
415415
Incremental Object Result must point to the Pending Result that results in the
416-
shortest `subPath`.
416+
shortest path.
417417

418418
If any field errors were raised during the execution of the results in `data`
419419
and these errors propagated to a path higher than the Incremental Object

0 commit comments

Comments
 (0)