From 5b7d4b9af8776b40c3f36abbab62d58bd608386f Mon Sep 17 00:00:00 2001 From: EntireTwix Date: Fri, 9 Jul 2021 15:37:58 -0700 Subject: [PATCH] :books::construction: docs --- docs/connected_services/how_to/endpoints.md | 28 +++++++++++---------- 1 file changed, 15 insertions(+), 13 deletions(-) diff --git a/docs/connected_services/how_to/endpoints.md b/docs/connected_services/how_to/endpoints.md index aa902df..dffc2a2 100644 --- a/docs/connected_services/how_to/endpoints.md +++ b/docs/connected_services/how_to/endpoints.md @@ -14,21 +14,23 @@ :heavy_multiplication_x: ### Usage endpoints -| 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: | -| 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: | +| 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: | +| 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: | +| SendFunds | sends funds from the authenticated user to the user `{name}` given in the json | {"name":string, "amount":uint32} | api/v1/user/transfer | `POST` | `N/A` | `N/A` | :heavy_check_mark: | :heavy_check_mark: | :heavy_multiplication_x: | :heavy_check_mark: | ### Usage enpoints errors -| name | 400 | 401 | 404 | 406 | -| :----- | :----------------------: | :----------------------: | :----------------: | :----------------: | -| GetBal | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_check_mark: | :heavy_check_mark: | -| GetLog | :heavy_multiplication_x: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | +| name | 400 | 401 | 404 | 406 | +| :-------- | :----------------------: | :----------------------: | :----------------: | :----------------: | +| GetBal | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_check_mark: | :heavy_check_mark: | +| GetLog | :heavy_multiplication_x: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | +| SendFunds | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | ### Usage endpoints support `v` denoting the API version -| name | v1 | -| :----- | :----------------: | -| GetBal | :heavy_check_mark: | -| GetLog | :heavy_check_mark: | - +| name | v1 | +| :-------- | :----------------: | +| GetBal | :heavy_check_mark: | +| GetLog | :heavy_check_mark: | +| SendFunds | :heavy_check_mark: |