@@ -10,7 +10,7 @@ the case that any _field error_ was raised on a field and was replaced with
10
10
11
11
## Response Format
12
12
13
- A response to a GraphQL request must be a map or an event stream of maps.
13
+ A response to a GraphQL request must be a map or a response stream of maps.
14
14
15
15
If the request raised any errors, the response map must contain an entry with
16
16
key ` errors ` . The value of this entry is described in the "Errors" section. If
@@ -22,33 +22,33 @@ key `data`. The value of this entry is described in the "Data" section. If the
22
22
request failed before execution, due to a syntax error, missing information, or
23
23
validation error, this entry must not be present.
24
24
25
- When the response of the GraphQL operation is an event stream, the first value
25
+ When the response of the GraphQL operation is a response stream, the first value
26
26
will be the initial response. All subsequent values may contain an ` incremental `
27
27
entry, containing a list of Defer or Stream payloads.
28
28
29
29
The ` label ` and ` path ` entries on Defer and Stream payloads are used by clients
30
30
to identify the ` @defer ` or ` @stream ` directive from the GraphQL operation that
31
31
triggered this response to be included in an ` incremental ` entry on a value
32
- returned by the event stream. When a label is provided, the combination of these
33
- two entries will be unique across all Defer and Stream payloads returned in the
34
- event stream.
32
+ returned by the response stream. When a label is provided, the combination of
33
+ these two entries will be unique across all Defer and Stream payloads returned
34
+ in the response stream.
35
35
36
- If the response of the GraphQL operation is an event stream, each response map
36
+ If the response of the GraphQL operation is a response stream, each response map
37
37
must contain an entry with key ` hasNext ` . The value of this entry is ` true ` for
38
38
all but the last response in the stream. The value of this entry is ` false ` for
39
39
the last response of the stream. This entry is not required for GraphQL
40
40
operations that return a single response map.
41
41
42
- The GraphQL server may determine there are no more values in the event stream
42
+ The GraphQL server may determine there are no more values in the response stream
43
43
after a previous value with ` hasNext ` equal to ` true ` has been emitted. In this
44
- case the last value in the event stream should be a map without ` data ` , ` label ` ,
45
- and ` path ` entries, and a ` hasNext ` entry with a value of ` false ` .
44
+ case the last value in the response stream should be a map without ` data ` ,
45
+ ` label ` , and ` path ` entries, and a ` hasNext ` entry with a value of ` false ` .
46
46
47
47
The response map may also contain an entry with key ` extensions ` . This entry, if
48
48
set, must have a map as its value. This entry is reserved for implementors to
49
49
extend the protocol however they see fit, and hence there are no additional
50
- restrictions on its contents. When the response of the GraphQL operation is an
51
- event stream, implementors may send subsequent payloads containing only
50
+ restrictions on its contents. When the response of the GraphQL operation is a
51
+ response stream, implementors may send subsequent response maps containing only
52
52
` hasNext ` and ` extensions ` entries. Defer and Stream payloads may also contain
53
53
an entry with the key ` extensions ` , also reserved for implementors to extend the
54
54
protocol however they see fit.
@@ -267,7 +267,7 @@ discouraged.
267
267
### Incremental
268
268
269
269
The ` incremental ` entry in the response is a non-empty list of Defer or Stream
270
- payloads. If the response of the GraphQL operation is an event stream, this
270
+ payloads. If the response of the GraphQL operation is a response stream, this
271
271
field may appear on both the initial and subsequent values.
272
272
273
273
#### Stream payload
0 commit comments