From 4cfa4991278adc37f33d7ef6199ce9994140006c Mon Sep 17 00:00:00 2001 From: EntireTwix Date: Thu, 15 Jul 2021 13:28:13 -0700 Subject: [PATCH] :construction::books: --- docs/building.md | 2 +- docs/connected_services/how_to/endpoints.md | 23 +++++++++++++++++---- 2 files changed, 20 insertions(+), 5 deletions(-) diff --git a/docs/building.md b/docs/building.md index e90f9da..2e3c866 100644 --- a/docs/building.md +++ b/docs/building.md @@ -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 | -simply running +EXAMPLE: ``` cmake .. ``` diff --git a/docs/connected_services/how_to/endpoints.md b/docs/connected_services/how_to/endpoints.md index 8e55d7a..5d97076 100644 --- a/docs/connected_services/how_to/endpoints.md +++ b/docs/connected_services/how_to/endpoints.md @@ -13,6 +13,8 @@ :heavy_check_mark: :heavy_multiplication_x: +## all error responses have JSON string along with them to describe + ### Usage endpoints | 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: | | 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 | | :------------- | :----------------------: | :----------------------: | :----------------------: | :----------------: | :----------------: | | 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: | | 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 endpoints support +### Usage endpoint support `v` denoting the API version | name | v1 | | :------------- | :----------------: | @@ -39,3 +39,18 @@ all error responses have JSON string along with them to describe | GetLog | :heavy_check_mark: | | SendFunds | :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: | \ No newline at end of file