mirror of
https://github.com/Expand-sys/CCash
synced 2026-03-22 20:47:10 +11:00
📚🚧 docs
This commit is contained in:
parent
a46adc28f9
commit
7d61ee5f83
1 changed files with 4 additions and 4 deletions
|
|
@ -15,9 +15,9 @@
|
||||||
|
|
||||||
### Usage endpoints
|
### Usage endpoints
|
||||||
| name | purpose | json input | path | HTTP Method | return type | return value | Jresp | Jreq | A | U |
|
| name | purpose | json input | path | HTTP Method | return type | return value | Jresp | Jreq | A | U |
|
||||||
| :----- | ------------------------------------------------------------------------- | ---------- | --------------------------------- | :---------: | :------------: | :------------------------------------------: | :----------------: | :----------------------: | :----------------------: | :----------------------: |
|
| :----- | ------------------------------------------------------------------------- | ---------- | ------------------------------ | :---------: | :------------: | :------------------------------------------: | :----------------: | :----------------------: | :----------------------: | :----------------------: |
|
||||||
| GetBal | retrieving the balance of a given user, `{name}` | `N/A` | `api/v1/user/balance?name={name}` | `GET` | uint32 | the user's balance | :heavy_check_mark: | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_multiplication_x: |
|
| GetBal | retrieving the balance of a given user, `{name}` | `N/A` | api/v1/user/balance?name={name | `GET` | uint32 | the user's balance | :heavy_check_mark: | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_multiplication_x: |
|
||||||
| GetLog | retrieves the logs of a given user, length varies by server configuration | `N/A` | `api/v1/user/log` | `GET` | array of jsons | {"to":string, "amount":uint32, "time":int64} | :heavy_check_mark: | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_check_mark: |
|
| GetLog | retrieves the logs of a given user, length varies by server configuration | `N/A` | api/v1/user/log | `GET` | array of jsons | {"to":string, "amount":uint32, "time":int64} | :heavy_check_mark: | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_check_mark: |
|
||||||
|
|
||||||
### Usage enpoints errors
|
### Usage enpoints errors
|
||||||
| name | 400 | 401 | 404 | 406 |
|
| name | 400 | 401 | 404 | 406 |
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue