added templating
This commit is contained in:
Hendrik Schlehlein 2019-01-17 22:10:06 +01:00
commit 872dd200e1

View file

@ -3,7 +3,9 @@
A TS3 Viewer with REST API.
# Features
## Config
The config file is generated automatically on first startup.
```json
{
@ -21,12 +23,16 @@ The config file is generated automatically on first startup.
}
}
```
## URL-Parameter
| Name | Type | Description |
| ---------- | -------- | ------------------------ |
| `pretty` | `bool` | pretty-prints JSON |
| `envelope` | `bool` | wraps JSON in data array |
## Channels
- **`GET`** `/v1/channels/:id`
- **`GET`** `/v1/channels`
```json
@ -39,7 +45,9 @@ The config file is generated automatically on first startup.
"awayMessage": ""
}
```
## Clients
- **`GET`** `/v1/clients/:id`
- **`GET`** `/v1/clients/`
```json
@ -53,7 +61,9 @@ The config file is generated automatically on first startup.
"neededSubscribePower": 0
}
```
## Server
- **`GET`** `/v1/server/info`
```json
{