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

🚧📚

Browse source
This commit is contained in:
EntireTwix 2021-07-15 13:28:13 -07:00
parent 66fa73ed24
commit 4cfa499127
2 changed files with 20 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/building.md
View file

@ -67,7 +67,7 @@ there are multiple flags responsible configuring CCash:
| RETURN_ON_DEL_NAME | `N/A` | when defined, return on delete will be toggled and any accounts deleted will send their funds to the defined account, this prevent currency destruction | prevents destruction of currency | deleting accounts is made slower | | RETURN_ON_DEL_NAME | `N/A` | when defined, return on delete will be toggled and any accounts deleted will send their funds to the defined account, this prevent currency destruction | prevents destruction of currency | deleting accounts is made slower |
simply running EXAMPLE:
``` ```
cmake .. cmake ..
``` ```

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

@ -13,6 +13,8 @@
:heavy_check_mark: :heavy_check_mark:
:heavy_multiplication_x: :heavy_multiplication_x:
## all error responses have JSON string along with them to describe
### Usage endpoints ### Usage endpoints
| name | purpose | json input | path | HTTP Method | correct status | return type | return value | Jresp | Jreq | A | U | | name | purpose | json input | path | HTTP Method | correct status | return type | return value | Jresp | Jreq | A | U |
| :------------- | ------------------------------------------------------------------------------ | -------------------------------- | ------------------------------- | :---------: | :------------: | :--------------: | :--------------------------------------------: | :----------------: | :----------------------: | :----------------------: | :----------------------: | | :------------- | ------------------------------------------------------------------------------ | -------------------------------- | ------------------------------- | :---------: | :------------: | :--------------: | :--------------------------------------------: | :----------------: | :----------------------: | :----------------------: | :----------------------: |
@ -21,7 +23,7 @@
| SendFunds | sends funds from the authenticated user to the user `{name}` given in the json | {"name":string, "amount":uint32} | api/v1/user/transfer | `POST` | 200 | uint32 | the user's balance after the transaction | :heavy_check_mark: | :heavy_check_mark: | :heavy_multiplication_x: | :heavy_check_mark: | | SendFunds | sends funds from the authenticated user to the user `{name}` given in the json | {"name":string, "amount":uint32} | api/v1/user/transfer | `POST` | 200 | uint32 | the user's balance after the transaction | :heavy_check_mark: | :heavy_check_mark: | :heavy_multiplication_x: | :heavy_check_mark: |
| VerifyPassword | verifies the credentials, used for connected services for ease of use | `N/A` | api/v1/user/verify_password | `POST` | 204 | `N/A` | `N/A` | :heavy_check_mark: | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_check_mark: | | VerifyPassword | verifies the credentials, used for connected services for ease of use | `N/A` | api/v1/user/verify_password | `POST` | 204 | `N/A` | `N/A` | :heavy_check_mark: | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_check_mark: |
### Usage enpoints errors ### Usage enpoint errors
| name | 400 | 401 | 404 | 405 | 406 | | name | 400 | 401 | 404 | 405 | 406 |
| :------------- | :----------------------: | :----------------------: | :----------------------: | :----------------: | :----------------: | | :------------- | :----------------------: | :----------------------: | :----------------------: | :----------------: | :----------------: |
| GetBal | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | GetBal | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
@ -29,9 +31,7 @@
| SendFunds | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | SendFunds | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| VerifyPassword | :heavy_multiplication_x: | :heavy_check_mark: | :heavy_multiplication_x: | :heavy_check_mark: | :heavy_check_mark: | | VerifyPassword | :heavy_multiplication_x: | :heavy_check_mark: | :heavy_multiplication_x: | :heavy_check_mark: | :heavy_check_mark: |
all error responses have JSON string along with them to describe ### Usage endpoint support
### Usage endpoints support
`v` denoting the API version `v` denoting the API version
| name | v1 | | name | v1 |
| :------------- | :----------------: | | :------------- | :----------------: |
@ -39,3 +39,18 @@ all error responses have JSON string along with them to describe
| GetLog | :heavy_check_mark: | | GetLog | :heavy_check_mark: |
| SendFunds | :heavy_check_mark: | | SendFunds | :heavy_check_mark: |
| VerifyPassword | :heavy_check_mark: | | VerifyPassword | :heavy_check_mark: |
### Meta endpoints
| name | purpose | json input | path | HTTP Method | correct status | return type | return value | Jresp | Jreq | A | U |
| :------------- | ----------------------------------------------- | --------------- | --------------------------- | :---------: | :------------: | :---------: | :----------: | :----------------: | :----------------: | :----------------------: | :----------------: |
| ChangePassword | to change the password of of 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: |
### Meta endpoint errors
| name | 400 | 401 | 404 | 405 | 406 |
| :------------- | :----------------: | :----------------------: | :----------------------: | :----------------------: | :----------------------: |
| ChangePassword | :heavy_check_mark: | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_multiplication_x: |
### Meta endpoint support
| name | v1 |
| :------------- | :----------------: |
| ChangePassword | :heavy_check_mark: |