From 2ed8597e94a7411c0e5587db36c3e642cef4642c Mon Sep 17 00:00:00 2001 From: Keith Irwin Date: Wed, 12 Apr 2023 22:06:51 -0600 Subject: [PATCH] #9 Finished documentation --- USAGE.md | 33 +++++++++++++++++++++++++-------- 1 file changed, 25 insertions(+), 8 deletions(-) diff --git a/USAGE.md b/USAGE.md index 31bab3d..48daaf3 100644 --- a/USAGE.md +++ b/USAGE.md @@ -175,14 +175,31 @@ The admin API has no authentication so it should be blocked to all except admin - `404`: Peer not found - `500`: Other server error -#### 2.2.4. List users +#### 2.2.4. Add user -TODO +- **REQUEST:** `POST /user` +- **FILE:** `back/lib/admin/user/add` +- **QUERYSTRING:** `?t=$token&host=$hostname&user=$username` + - `t`: The token from a GET request + - `host`: The hostname chosen for the new peer + - `user`: The username chosen +- **RESPONSE:** + - `202`: Added + - `400`: Invalid input + - `403`: Bad token + - `409`: Username already taken + - `500`: Error -#### 2.2.5. Add user +#### 2.2.5. Delete user -TODO - -#### 2.2.6. Delete user - -TODO +- **REQUEST:** `DELETE /user` +- **FILE:** `back/lib/admin/user/del` +- **QUERYSTRING:** `?t=$token&user=$username&un=$usernumber` + - `t`: The token from a GET request + - `user`: The username to delete + - `un`: The user's subnet number +- **RESPONSE:** + - `202`: Deleted + - `400`: Bad username or number + - `403`: Bad token + - `500`: Other server error