docs: update /server/info documentation

Note the addition of the "websocket_count" field.

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
This commit is contained in:
Eric Callahan 2021-09-21 11:35:58 -04:00
parent b1d739e032
commit 83eddf5e7d
1 changed files with 4 additions and 1 deletions

View File

@ -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