From 272a2bca67236880519e03509fbe3433d10f2b16 Mon Sep 17 00:00:00 2001 From: EntireTwix Date: Thu, 10 Jun 2021 22:08:23 -0700 Subject: [PATCH] updated docs with changes --- src/bank_f.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/bank_f.cpp b/src/bank_f.cpp index b3b0385..aea592a 100644 --- a/src/bank_f.cpp +++ b/src/bank_f.cpp @@ -32,7 +32,7 @@ void BankF::Help(req_args) const { auto resp = HttpResponse::newHttpResponse(); auto handlerInfo = app().getHandlersInfo(); - resp->setBody("

Error Responses

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

Things of Note

Usage

Name Path Method A Description
GetBal /{name}/bal GET true returns the balance of a given user {name}
GetLog /{name}/log GET true returns a list of last n number of transactions (a configurable amount) of a given user {name}
SendFunds /{name}/send/{to}/amount={amount} POST true sends {amount} from user {name} to user {to}
VerifyPassword /{name}/PASS_HEADER/verify GET true returns true or false depending on if the supplied user {name}'s PASS_HEADERword matches the PASS_HEADERword supplied in the header

Meta Usage

Name Path Method A Description
ChangePassword /{name}/PASS_HEADER/change PATCH true if the PASS_HEADERword supplied in the header matches the user {name}'s PASS_HEADERword, the user’s PASS_HEADERword is changed to the one given in the body
SetBal /admin/{name}/bal/amount={amount} PATCH true sets the balance of a give user {name} if the supplied PASS_HEADERword matches the admin PASS_HEADERword

System Usage

Name Path Method A Description
Help /help GET false the page you’re looking at right now!
Close /admin/close POST true saves and then closes the program if the supplied PASS_HEADERword matches the admin PASS_HEADERword
Contains /contains/{name} GET false returns true or false depending on if the supplied user {name} exists
AdminVerifyPass /admin/verify GET true returns true or false depending on if the PASS_HEADERword supplied in the header matches the admin PASS_HEADERword

User Management

Name Path Method A Description
AddUser /user/{name} POST false registers a user with the name {name}, balance of 0 and a PASS_HEADERword of the PASS_HEADERword supplied in the header
AdminAddUser /admin/user/{name}?init_bal={init_bal} POST true if the PASS_HEADERword supplied in the header matches the admin PASS_HEADERword, then it registers a user with the name {name}, balance of init_bal and a PASS_HEADERword supplied by the body of the request
DelUser /user/{name} DELETE true if the PASS_HEADERword supplied in the header matches the user {name}'s PASS_HEADERword, then the user is deleted
AdminDelUser /admin/user/{name} DELETE true if the PASS_HEADERword supplied in the header matches the admin PASS_HEADERword, then the user is deleted
"); + resp->setBody("

Error Responses

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

Things of Note

Usage

Name Path Method A Description
GetBal /{name}/bal GET false returns the balance of a given user {name}
GetLog /{name}/log GET true returns a list of last n number of transactions (a configurable amount) of a given user {name}
SendFunds /{name}/send/{to}/amount={amount} POST true sends {amount} from user {name} to user {to}
VerifyPassword /{name}/pass/verify GET true returns true or false depending on if the supplied user {name}'s password matches the password supplied in the header

Meta Usage

Name Path Method A Description
ChangePassword /{name}/pass/change PATCH true if 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} PATCH true sets the balance of a give user {name} if the supplied password matches the admin password

System Usage

Name Path Method A Description
Help /help GET false the page you’re looking at right now!
Close /admin/close POST true saves and then closes the program if the supplied password matches the admin password
Contains /contains/{name} GET false returns true or false depending on if the supplied user {name} exists
AdminVerifyPass /admin/verify GET true returns true or false depending on if the password supplied in the header matches the admin password

User Management

Name Path Method A Description
AddUser /user/{name} POST true registers 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} POST true if 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} DELETE true if the password supplied in the header matches the user {name}'s password, then the user is deleted
AdminDelUser /admin/user/{name} DELETE true if the password supplied in the header matches the admin password, then the user is deleted
"); resp->setExpiredTime(0); callback(resp); }