mirror of
https://github.com/Expand-sys/CCash
synced 2026-03-22 20:47:10 +11:00
✨ ping function
This commit is contained in:
parent
3e857f455e
commit
8f47c12450
2 changed files with 16 additions and 10 deletions
10
help.md
10
help.md
|
|
@ -1,14 +1,13 @@
|
||||||
# Error Responses
|
# Error Responses
|
||||||
|
|
||||||
| # | meaning |
|
| # | meaning |
|
||||||
| --- | ------------------ |
|
| --- | ----------------- |
|
||||||
| -1 | UserNotFound |
|
| -1 | UserNotFound |
|
||||||
| -2 | WrongPassword |
|
| -2 | WrongPassword |
|
||||||
| -3 | InvalidRequest |
|
| -3 | InvalidRequest |
|
||||||
| -4 | WrongAdminPassword |
|
| -4 | NameTooLong |
|
||||||
| -5 | NameTooLong |
|
| -5 | UserAlreadyExists |
|
||||||
| -6 | UserAlreadyExists |
|
| -6 | InsufficientFunds |
|
||||||
| -7 | InsufficientFunds |
|
|
||||||
|
|
||||||
# Things of Note
|
# Things of Note
|
||||||
* all endpoints respond with **JSON** file type
|
* all endpoints respond with **JSON** file type
|
||||||
|
|
@ -32,6 +31,7 @@
|
||||||
| Name | Path | Method | A | Description |
|
| Name | Path | Method | A | Description |
|
||||||
| :-------------: | :--------------- | :----: | :---: | ------------------------------------------------------------------------------------- |
|
| :-------------: | :--------------- | :----: | :---: | ------------------------------------------------------------------------------------- |
|
||||||
| Help | /help | GET | false | the page you're looking at right now! |
|
| 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 |
|
| 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 |
|
| 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 |
|
| AdminVerifyPass | /admin/verify | GET | true | returns `1` if the password supplied in the header matches the admin password |
|
||||||
|
|
|
||||||
File diff suppressed because one or more lines are too long
Loading…
Reference in a new issue