update documentation

This commit is contained in:
Minecon724 2024-08-23 17:12:29 +02:00
parent 51f68df50e
commit f4b7e0abde
Signed by: Minecon724
GPG key ID: 3CCC4D267742C8E8
2 changed files with 30 additions and 1 deletions

29
DOCS.md Normal file
View file

@ -0,0 +1,29 @@
Docs for almost every API path \
Authentication is done with the `X-Token` header (doesn't apply to websocket see `PROTOCOL.md` for that) \
All responses are in JSON, request body if required must also be JSON \
TODO document errors
## Paths
### `/api/tokens/create`
Required role: `admin`
Method: `PUT`
Request body:
- `accessLimits`: the label of access limits
Response body:
- `token`: the generated token (base64 encoded)
### `/api/tokens/me`
Required role: `user`
Method: `GET`
Response body:
- `token`: the token itself but only first and last 5 characters visible separated by ...
- `role`: the role like user or admin
- `accessLimits`: the label of access limits

View file

@ -1,7 +1,7 @@
This file documents the websocket /api/ws
## Message format
lways bytes! \
Always bytes! \
Packet id followed by arguments \
Some packets don't have arguments so send just the packet id \
There can be multiple packets in one message, those with unknown amount of arguments have to be terminated \