diff --git a/help.md b/help.md index 00ae6aa..c85cf77 100644 --- a/help.md +++ b/help.md @@ -22,24 +22,24 @@ | VerifyPassword | /{name}/pass/verify | GET | true | returns `1` 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 | +| Name | Path | Method | A | Description | +| :------------: | :------------------------------------- | :----: | :---: | ---------------------------------------------------------------------------------------------------------------------------------------- | +| ChangePassword | BankF/{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 | BankF/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! | -| Ping | /ping | GET | false | for pinging the server to see if its online | -| 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 `1` if the password supplied in the header matches the admin password | +| Name | Path | Method | A | Description | +| :-------------: | :-------------------- | :----: | :---: | ------------------------------------------------------------------------------------- | +| Help | BankF/help | GET | false | the page you're looking at right now! | +| Ping | BankF/ping | GET | false | for pinging the server to see if its online | +| Close | BankF/admin/close | POST | true | saves and then closes the program if the supplied password matches the admin password | +| Contains | BankF/contains/{name} | GET | false | returns `true` or `false` depending on if the supplied user `{name}` exists | +| AdminVerifyPass | BankF/admin/verify | GET | true | returns `1` 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 | \ No newline at end of file +| Name | Path | Method | A | Description | +| :----------: | :------------------------------------------ | :----: | :---: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| AddUser | BankF/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 | BankF/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 | BankF/user/{name} | DELETE | true | if the password supplied in the header matches the user `{name}`'s password, then the user is deleted | +| AdminDelUser | BankF/admin/user/{name} | DELETE | true | if the password supplied in the header matches the admin password, then the user is deleted | \ No newline at end of file