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-15 18:44:25 -07:00
parent c2da258143
commit 86fa298e04
1 changed files with 13 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -45,7 +45,7 @@
| :------------------ | -------------------------------------------------------------------------------------------------- | ------------------------------- | --------------------------------- | :---------: | :------------: | :---------: | :----------------------------: | :----------------: | :----------------: | :----------------------: | :----------------------: |
| ChangePassword | changes the password of the Authenticated user | {"pass":string} | api/v1/user/change_password | `PATCH` | 204 | `N/A` | `N/A` | :heavy_check_mark: | :heavy_check_mark: | :heavy_multiplication_x: | :heavy_check_mark: |
| AdminChangePassword | changes the password of a given user `{name}` | {"name":string,"pass":string} | api/v1/admin/user/change_password | `PATCH` | 204 | `N/A` | `N/A` | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_multiplication_x: |
| SetBal | sets the balance of a give users `{name}` | {"name":string,"amount":uint32} | api/v1/admin/set_balance | `PATCH` | 204 | `N/A` | `N/A` | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_multiplication_x: |
| SetBal | sets the balance of a given user `{name}` | {"name":string,"amount":uint32} | api/v1/admin/set_balance | `PATCH` | 204 | `N/A` | `N/A` | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_multiplication_x: |
| ImpactBal | modifies the user `{name}`'s balance by `{amount}` if positive itll add, if negative itll subtract | {"name":string,"amount":uint32} | api/v1/admin/impact_balance | `POST` | 200 | uint32_t | new balance after modification | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_multiplication_x: |
### Meta Usage endpoint errors
@ -65,16 +65,19 @@
| 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` | `N/A` | `N/A` | :heavy_multiplication_x: | :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` | `N/A` | `N/A` | :heavy_multiplication_x: | :heavy_multiplication_x: |
| Close | saves & closes the CCash webserver | `N/A` | api/v1/close | `POST` | 204 | `N/A` | `N/A` | :heavy_check_mark: | `N/A` | :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: |
| 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: |
### System Usage endpoint support
| name | v1 |
| :--- | :----------------: |
| Help | :heavy_check_mark: |
| name | v1 |
| :---- | :----------------: |
| Help | :heavy_check_mark: |
| Close | :heavy_check_mark: |