From fcb2d471d235037c04530a93225ca7f7280c7a14 Mon Sep 17 00:00:00 2001 From: Jonni Liljamo Date: Fri, 20 Jan 2023 10:00:22 +0200 Subject: [PATCH] docs(sdbapi): API doc updates --- sdbapi/README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/sdbapi/README.md b/sdbapi/README.md index cbe2008..32e613a 100644 --- a/sdbapi/README.md +++ b/sdbapi/README.md @@ -4,6 +4,8 @@ Configure `SDBAPI_JWT_SECRET` in `docker-compose.yaml` to be randomized. ## API Doc +Paths may change in the future. + | path | action | who can | |------|--------|---------| | GET /info | get API info | public | @@ -13,8 +15,8 @@ Configure `SDBAPI_JWT_SECRET` in `docker-compose.yaml` to be randomized. | GET /user/:id | get generic user info | public | | GET /user/_/:id | get private user info | id owner | |-|-|-| -| GET /game/:id | get game info | registered users | +| GET /game/:id | get game info | registered users (subject to change) | | GET /game/get_forming | get all games that are forming | registered users | | POST /game/create | create a game | registered users | | PATCH /game/:id/state | change the state of a game | only the game creator, aka P1 | - +| GET /game/for_user/:id | get all games for a user | id owner (subject to change) | -- 2.44.1