Netflix / dgs-framework

GraphQL for Java with Spring Boot made easy.
https://netflix.github.io/dgs
Apache License 2.0
3.03k stars 286 forks source link

documentation: Incorrect Information in DGS Framework Documentation Regarding WebSocket Sub-Protocols #1899

Closed kobinarth-panchalingam closed 1 month ago

kobinarth-panchalingam commented 2 months ago

What are you missing in the docs

image

The documentation for the DGS Framework currently contains incorrect information regarding the WebSocket sub-protocols graphql-transport-ws and graphql-ws. Specifically, the documentation states that graphql-ws is the deprecated sub-protocol, which is inaccurate. graphql-transport-ws is the deprecated sub-protocol, while graphql-ws is the newer protocol supported by the framework.

Proposed text

Update the correct subprotocol names.

srinivasankavitha commented 1 month ago

Thanks for pointing out the confusion. We are referring to the sub protocol names here, which are admittedly confusing. Please see https://www.apollographql.com/docs/react/data/subscriptions/#websocket-subprotocols The deprecated protocol is referred to as subscriptions-transport-ws uses graphql-ws as the sub protocol. I will update our docs to clarify this better.

srinivasankavitha commented 1 month ago

https://github.com/Netflix/dgs/pull/179