From 83eddf5e7df6e9cc477f0b3da91be2dac0b81146 Mon Sep 17 00:00:00 2001 From: Eric Callahan Date: Tue, 21 Sep 2021 11:35:58 -0400 Subject: [PATCH] docs: update /server/info documentation Note the addition of the "websocket_count" field. Signed-off-by: Eric Callahan --- docs/web_api.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/web_api.md b/docs/web_api.md index 6f92783..a00efc8 100644 --- a/docs/web_api.md +++ b/docs/web_api.md @@ -440,7 +440,8 @@ An object containing various fields that report server state. "warnings": [ "Invalid config option 'api_key_path' detected in section [authorization]. Remove the option to resolve this issue. In the future this will result in a startup error.", "Unparsed config section [fake_section] detected. This may be the result of a component that failed to load. In the future this will result in a startup error." - ] + ], + "websocket_count": 2 } ``` !!! warning @@ -456,6 +457,8 @@ component is available. Optional components that do not load correctly will not prevent the server from starting, thus any components that failed to load will be reported in the `failed_components` field. +The `websocket_count` field reports the total number of connected websockets. + #### Get Server Configuration HTTP request: ```http