search

enisdenjo / graphql-ws

Coherent, zero-dependency, lazy, simple, GraphQL over WebSocket Protocol compliant server and client.
https://the-guild.dev/graphql/ws
MIT License
1.75k stars 162 forks source link

docs(protocol): clarify id field is not optional #523

Closed roksui closed 1 year ago

roksui commented 1 year ago

This PR aims to clarify the section of the protocol which states that the id field is optional even though this field is either required or not present as per the type definitions. (Also discussed in #340)

At first, I wanted to mention specifically that Subscribe, Next, Error, and Complete message types needs to have the id field. However, the sentence that needs to be clarified is in the "Communication" section which comes before the explanation of the message types. So, I used the term "Messages corresponding to operations" to refer to those message types.

Though, I am not sure if this sentence sounds clear enough. I am happy to accept any improvements for wording.

enisdenjo commented 1 year ago

Thank you very much!

roksui commented 1 year ago

@enisdenjo Thank you! Should I be concerned about the failing check for this PR?

enisdenjo commented 1 year ago

Nope, it's just Deno acting up (it happens from time to time). 😅

enisdenjo commented 11 months ago

:tada: This PR is included in version 5.14.3 :tada:

The release is available on:

Your semantic-release bot :package::rocket: