From 394fc9777c67f0f2d2ffd212a2cd157fff711900 Mon Sep 17 00:00:00 2001 From: Rob Coleman Date: Tue, 9 Jul 2024 09:20:11 -0700 Subject: [PATCH] Clarify the meaning and usage of the "id" field in a websocket message (#2244) --- docs/api/websocket.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/websocket.md b/docs/api/websocket.md index d636bbbd..304b46ad 100644 --- a/docs/api/websocket.md +++ b/docs/api/websocket.md @@ -23,7 +23,7 @@ During the command phase, the client attaches a unique identifier to each messag ## Message format -Each API message is a JSON serialized object containing a `type` key. After the authentication phase messages also must contain an `id`, an integer that contains the number of interactions. +Each API message is a JSON serialized object containing a `type` key. After the authentication phase messages also must contain an `id`, an integer that the caller can use to correlate messages to responses. Example of an auth message: