feat: new endpoint client-server/stats
This commit is contained in:
parent
167772bfcd
commit
e2e4e932d6
1 changed files with 33 additions and 0 deletions
33
API/client-server/v1/stats.md
Normal file
33
API/client-server/v1/stats.md
Normal file
|
@ -0,0 +1,33 @@
|
|||
GET /v1/stats
|
||||
|
||||
---
|
||||
|
||||
## Request
|
||||
|
||||
No request parameters or request body.
|
||||
|
||||
---
|
||||
|
||||
## Responses
|
||||
|
||||
|Status|Description|
|
||||
|-|-|
|
||||
|200|The current stats of the server|
|
||||
|
||||
### 200 response
|
||||
|
||||
|Name|Type|Description|
|
||||
|-|-|-|
|
||||
|accounts|int|**Required**: The number of signed up accounts|
|
||||
|uptime|int|**Required**: How many seconds the server has been running|
|
||||
|version|string|**"Required**: The current server version|
|
||||
|build_number|string|The hash of the last commit in the git repo? (maybe we want to define this some other way)|
|
||||
|
||||
```json
|
||||
{
|
||||
"accounts": 27,
|
||||
"uptime": 189275,
|
||||
"version": "0.0.2",
|
||||
"build_number": "1fa926dd05"
|
||||
}
|
||||
```
|
Loading…
Add table
Add a link
Reference in a new issue