123niel/tsviewer
1
0
Fork 0
forked from Cliffbreak/tsviewer
Code Issues Pull requests Releases Wiki Activity

Merge branch 'master' of https://git.cliffbreak.de/Cliffbreak/tsviewer

Browse source 
added templating
This commit is contained in:
Hendrik Schlehlein 2019-01-17 22:10:06 +01:00
commit 872dd200e1
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

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