expand/CCash
1
0
Fork 0
mirror of https://github.com/Expand-sys/CCash synced 2025-12-16 16:12:14 +11:00
Code Issues Projects Releases Packages Wiki Activity Actions

📚🚧

Browse source
This commit is contained in:
EntireTwix 2021-07-17 21:28:24 -07:00
parent 8c660595c9
commit e4f022cf46
2 changed files with 26 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
docs/connected_services/how_to/endpoints.md
View file

@ -65,19 +65,25 @@
| ImpactBal | :heavy_check_mark: |
### Sytem Usage endpoints
| name | purpose | json input | path | HTTP Method | correct status | return type | return value | Jresp | Jreq | A | U |
| :---- | ---------------------------------- | ---------- | --------------------- | :---------: | :------------: | :---------: | :----------: | :----------------------: | :----------------------: | :----------------------: | :----------------------: |
| Help | redirects to GitHub projects Docs | `N/A` | api/v1/help | `GET` | 301 | `N/A` | `N/A` | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_multiplication_x: |
| Close | saves & closes the CCash webserver | `N/A` | api/v1/admin/shutdown | `POST` | 204 | `N/A` | `N/A` | :heavy_check_mark: | :heavy_multiplication_x: | :heavy_check_mark: | :heavy_multiplication_x: |
| name | purpose | json input | path | HTTP Method | correct status | return type | return value | Jresp | Jreq | A | U |
| :----------------- | ---------------------------------- | ---------- | ------------------------------ | :---------: | :------------: | :---------: | :----------: | :----------------------: | :----------------------: | :----------------------: | :----------------------: |
| Help | redirects to GitHub projects Docs | `N/A` | api/v1/help | `GET` | 301 | `N/A` | `N/A` | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_multiplication_x: |
| Close | saves & closes the CCash webserver | `N/A` | api/v1/admin/shutdown | `POST` | 204 | `N/A` | `N/A` | :heavy_check_mark: | :heavy_multiplication_x: | :heavy_check_mark: | :heavy_multiplication_x: |
| Contains | checks wether a user exists | `N/A` | api/v1/user/exists?name={name} | `GET` | 204 | `N/A` | `N/A` | :heavy_check_mark: | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_multiplication_x: |
| AdminVerifyAccount | checks wether a user is the admin | `N/A` | api/v1/admin/verify_account | `POST` | 204 | `N/A` | `N/A` | :heavy_check_mark: | :heavy_multiplication_x: | :heavy_check_mark: | :heavy_multiplication_x: |
### System Usage endpoin errors
| name | 400 | 401 | 404 | 406 |
| :---- | :----------------------: | :----------------------: | :----------------------: | :----------------------: |
| Help | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_multiplication_x: |
| Close | :heavy_multiplication_x: | :heavy_check_mark: | :heavy_multiplication_x: | :heavy_check_mark: |
| name | 400 | 401 | 404 | 406 |
| :----------------- | :----------------------: | :----------------------: | :----------------------: | :----------------------: |
| Help | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_multiplication_x: |
| Close | :heavy_multiplication_x: | :heavy_check_mark: | :heavy_multiplication_x: | :heavy_check_mark: |
| Contains | :heavy_multiplication_x: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| AdminVerifyAccount | :heavy_multiplication_x: | :heavy_check_mark: | :heavy_multiplication_x: | :heavy_check_mark: |
### System Usage endpoint support
| name | v1 |
| :---- | :----------------: |
| Help | :heavy_check_mark: |
| Close | :heavy_check_mark: |
| name | v1 |
| :----------------- | :----------------: |
| Help | :heavy_check_mark: | ` |
| Close | :heavy_check_mark: |
| Contains | :heavy_check_mark: |
| AdminVerifyAccount | :heavy_check_mark: |

16
docs/contributors.md
View file

@ -1,9 +1,9 @@
# Contributors
| name | work |
| :------------------------------------------ | ----------------------- |
| [Luke](https://github.com/LukeeeeBennett) | Docker package, JS API |
| [React](https://github.com/Reactified) | Logo, ComputerCraft API |
| [Doggo](https://github.com/FearlessDoggo21) | Python API, CCash CLI |
| [Expand](https://github.com/Expand-sys) | Fixed docker package |
| [Jolly](https://github.com/STBoyden) | Rust API |
| Caesay | Restful API suggestions |
| name | work |
| :------------------------------------------ | --------------------------------------- |
| [Luke](https://github.com/LukeeeeBennett) | Docker package, JS API |
| [React](https://github.com/Reactified) | Logo, ComputerCraft API |
| [Doggo](https://github.com/FearlessDoggo21) | HTTP suggestions, Python API, CCash CLI |
| [Expand](https://github.com/Expand-sys) | Fixed docker package |
| [Jolly](https://github.com/STBoyden) | Rust API |
| Caesay | Restful API suggestions |