File tree Expand file tree Collapse file tree 1 file changed +3
-26
lines changed
Expand file tree Collapse file tree 1 file changed +3
-26
lines changed Original file line number Diff line number Diff line change @@ -17,9 +17,8 @@ Reference: :class:`gql.transport.http_multipart_transport.HTTPMultipartTransport
1717
1818.. note ::
1919
20- This transport is specifically designed for GraphQL subscriptions. While it can handle
21- queries and mutations via the ``execute() `` method, standard HTTP transports like
22- :ref: `AIOHTTPTransport <aiohttp_transport >` are more efficient for those operations.
20+ This transport is specifically designed for GraphQL subscriptions. It does not support
21+ mutations or queries.
2322
2423.. literalinclude :: ../code_examples/http_multipart_async.py
2524
@@ -40,21 +39,7 @@ with GraphQL execution results.
4039Protocol Details
4140----------------
4241
43- **Message Format **
44-
45- Each message part follows this structure:
46-
47- .. code-block :: text
48-
49- --graphql
50- Content-Type: application/json
51-
52- {"payload": {"data": {...}, "errors": [...]}}
53-
54- **Heartbeats **
55-
56- Servers may send empty JSON objects (``{} ``) as heartbeat messages to keep the
57- connection alive. These are automatically filtered out by the transport.
42+ See https://www.apollographql.com/docs/graphos/routing/operations/subscriptions/multipart-protocol
5843
5944**Error Handling **
6045
@@ -63,14 +48,6 @@ The protocol distinguishes between two types of errors:
6348- **GraphQL errors **: Returned within the ``payload `` property alongside data
6449- **Transport errors **: Returned with a top-level ``errors `` field and ``null `` payload
6550
66- **End of Stream **
67-
68- The subscription ends when the server sends the final boundary marker:
69-
70- .. code-block :: text
71-
72- --graphql--
73-
7451Authentication
7552--------------
7653
You can’t perform that action at this time.
0 commit comments