From f441844ced0de218058866d876c0f73a62867e11 Mon Sep 17 00:00:00 2001 From: tycrek Date: Sat, 24 Dec 2022 21:08:03 -0700 Subject: [PATCH] docs: detail adding new users via API --- .github/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/README.md b/.github/README.md index ead4e41..09d44b6 100644 --- a/.github/README.md +++ b/.github/README.md @@ -382,8 +382,10 @@ Other things to note: | **`GET /user/all`** | Returns a list of all users | Yes | | **`GET /user/self`** | Returns the current user | No | | **`GET /user/token/:token`** | Returns the user with the given token | No | -| **`POST /user/reset`** | Resets the current user's **password** (token resets coming soon) | No | +| **`POST /user/reset`** | Resets the current user's **password** (token resets coming soon). Request body must be a JSON object including `username` and `password`. | No | | **`GET /user/:id`** | Returns the user with the given ID | Yes | +| **`POST /user/new`** | Creates a new user. Request body must be a JSON object including `username` and `password`. You may optionally include `admin` (boolean) or `meta` (object). Returns 400 if fails. | Yes | + ## Custom frontends - OUTDATED