From a025954b7453496d5dd30c75ae914ed866b34fd1 Mon Sep 17 00:00:00 2001 From: William Katz Date: Thu, 10 Jun 2021 13:20:18 -0700 Subject: [PATCH] Delete help.html --- help.html | 198 ------------------------------------------------------ 1 file changed, 198 deletions(-) delete mode 100644 help.html diff --git a/help.html b/help.html deleted file mode 100644 index a233d6e..0000000 --- a/help.html +++ /dev/null @@ -1,198 +0,0 @@ -

Error Responses

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
#meaning
-1UserNotFound
-2WrongPassword
-3InvalidRequest
-4WrongAdminPassword
-5NameTooLong
-6UserAlreadyExists
-7InsufficientFunds
-

Things of Note

- -

Usage

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NamePathMethodADescription
GetBal/{name}/balGETtruereturns the balance of a given user {name}
GetLog/{name}/logGETtruereturns a list of last n number of transactions (a configurable amount) of a given user {name}
SendFunds/{name}/send/{to}/amount={amount}POSTfalsesends {amount} from user {name} to user {to}
VerifyPassword/{name}/pass/verifyGETtruereturns true or false depending on if the supplied user {name}'s password matches the password supplied in the header
-

Meta Usage

- - - - - - - - - - - - - - - - - - - - - - - - - - -
NamePathMethodADescription
ChangePassword/{name}/pass/changePATCHtrueif the password supplied in the header matches the user {name}'s password, the user’s password is changed to the one given in the body
SetBal/admin/{name}/bal/amount={amount}PATCHtruesets the balance of a give user {name} if the supplied password matches the admin password
-

System Usage

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NamePathMethodADescription
Help/helpGETfalsethe page you’re looking at right now!
Close/admin/closePOSTtruesaves and then closes the program if the supplied password matches the admin password
Contains/contains/{name}GETfalsereturns true or false depending on if the supplied user {name} exists
AdminVerifyPass/admin/verifyGETtruereturns true or false depending on if the password supplied in the header matches the admin password
-

User Management

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NamePathMethodADescription
AddUser/user/{name}POSTtrueregisters a user with the name {name}, balance of 0 and a password of the password supplied in the header
AdminAddUser/admin/user/{name}?init_bal={init_bal}POSTtrueif the password supplied in the header matches the admin password, then it registers a user with the name {name}, balance of init_bal and a password supplied by the body of the request
DelUser/user/{name}DELETEtrueif the password supplied in the header matches the user {name}'s password, then the user is deleted
AdminDelUser/admin/user/{name}DELETEtrueif the password supplied in the header matches the admin password, then the user is deleted
\ No newline at end of file