From a82be822239dafafdb05d0ff895b480269b009be Mon Sep 17 00:00:00 2001 From: Assaf Packin Date: Thu, 11 Jul 2024 16:03:42 -0400 Subject: [PATCH] Update GraphQLProtocol documentation The Graphql-ws library does implement graphqlTransportWs now. See their readme: https://github.com/enisdenjo/graphql-ws/blob/master/PROTOCOL.md#communication "The WebSocket sub-protocol for this specification is: graphql-transport-ws." --- .../lib/src/links/websocket_link/websocket_client.dart | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/packages/graphql/lib/src/links/websocket_link/websocket_client.dart b/packages/graphql/lib/src/links/websocket_link/websocket_client.dart index ecca76c8..233dd759 100644 --- a/packages/graphql/lib/src/links/websocket_link/websocket_client.dart +++ b/packages/graphql/lib/src/links/websocket_link/websocket_client.dart @@ -176,15 +176,13 @@ class SocketSubProtocol { class GraphQLProtocol { GraphQLProtocol._(); - /// graphql-ws: The new (not to be confused with the graphql-ws library). + /// graphql-ws: Old protocol (not to be confused with the graphql-ws library). /// NB. This protocol is it no longer maintained, please consider /// to use `SocketSubProtocol.graphqlTransportWs`. static const String graphqlWs = "graphql-ws"; - /// graphql-transport-ws: New ws protocol used by most Apollo Server instances - /// with subscriptions enabled use this library. - /// N.B: not to be confused with the graphql-ws library that implement the - /// old ws protocol. + /// graphql-transport-ws: New protocol used by most Apollo Server instances + /// with subscriptions enabled. Implemented by the graphql-ws library. static const String graphqlTransportWs = "graphql-transport-ws"; }