Document the SSE handler for subscriptions

esl · Nov 8, 2022 · 95cfce5 · 95cfce5
1 parent 82ce031
commit 95cfce5
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/doc/graphql-api/Admin-GraphQL.md b/doc/graphql-api/Admin-GraphQL.md
@@ -6,6 +6,10 @@ We can distinguish two levels of the administration. A global admin (has access
 
 There is only one schema for both admin types. Admin per domain simply has no permissions to execute global commands or commands with not owned domain. The API documentation clearly says which commands are global.
 
+**Queries** and **mutations** can be executed with the POST or GET method, as specified in the [GraphQL documentation](https://graphql.org/learn/serving-over-http/). The endpoint URL is as configured in the Listen section, e.g. `http://localhost:5551/api/graphql` for the global admin.
+
+**Subscriptions** can be executed with the GET method, and are handled with [Server-Sent Events (SSE)](https://html.spec.whatwg.org/multipage/server-sent-events.html). The endpoint URL is the same as for regular queries with the addition of `/sse`, e.g. `http://localhost:5551/api/graphql/sse` for the global admin.
+
 ## Domain admin configuration
 
 Out of the box, domains are created with a disabled admin account. Admin per domain can be enabled only by the global admin with the command

diff --git a/doc/graphql-api/User-GraphQL.md b/doc/graphql-api/User-GraphQL.md
@@ -2,6 +2,10 @@
 
 The new GraphQL user API contains all commands from the client REST API and provides plenty of new ones. Multiple commands previously available only for the admin have their counterparts for the user.
 
+**Queries** and **mutations** can be executed with the POST or GET method, as specified in the [GraphQL documentation](https://graphql.org/learn/serving-over-http/). The endpoint URL is as configured in the Listen section, e.g. `http://localhost:5561/api/graphql`.
+
+**Subscriptions** can be executed with the GET method, and are handled with [Server-Sent Events (SSE)](https://html.spec.whatwg.org/multipage/server-sent-events.html). The endpoint URL is the same as for regular queries with the addition of `/sse`, e.g. `http://localhost:5561/api/graphql/sse`.
+
 ## Authentication
 
 MongooseIM uses *Basic Authentication* as the authentication method for the GraphQL API.