Skip to content

Commit

Permalink
docs(protocol): payload is not always optional
Browse files Browse the repository at this point in the history
Co-authored-by: Denis Badurina <[email protected]>
  • Loading branch information
roksui and enisdenjo authored Nov 29, 2023
1 parent eb8e02c commit 0aa205b
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion PROTOCOL.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The WebSocket sub-protocol for this specification is: `graphql-transport-ws`.

Messages are represented through the JSON structure and are stringified before being sent over the network. They are bidirectional, meaning both the server and the client must conform to the specified message structure.

**All** messages contain the `type` field outlining the action this message describes. Depending on the type, the message can contain the _optional_ field `payload` holding the extra "payload" information to go with the specific message type.
**All** messages contain the `type` field outlining the action this message describes.

Messages corresponding to operations contain the `id` field used for uniquely identifying server responses and connecting them with the client's requests.

Expand Down

0 comments on commit 0aa205b

Please sign in to comment.