docs: add documentation for "/server/config" endpoint

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
This commit is contained in:
Arksine 2021-02-16 11:43:31 -05:00
parent 60ba8ff1d5
commit eb37ce767d
1 changed files with 24 additions and 0 deletions

View File

@ -227,6 +227,30 @@ websocket. See the `notify_status_update` notification for details.
enabled plugins. This can be used by clients to check if an optional enabled plugins. This can be used by clients to check if an optional
plugin is available. plugin is available.
### Get Server Configuration
- HTTP command:\
`GET /server/config`
- Websocket command:
`{jsonrpc: "2.0", method: "server.config", id: <request id>}`
- Returns:\
An object containing the server's configuration, structured as follows:
```json
{
config: {
server: {
...
},
authorization: {
...
},
...
}
}
```
### Fetch stored temperature data ### Fetch stored temperature data
- HTTP command:\ - HTTP command:\
`GET /server/temperature_store` `GET /server/temperature_store`