From cc9196dce5e7bebda5b3cd2d7052d332675aa05c Mon Sep 17 00:00:00 2001 From: EntireTwix Date: Thu, 15 Jul 2021 18:31:41 -0700 Subject: [PATCH] :books::construction: --- docs/connected_services/how_to/endpoints.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/docs/connected_services/how_to/endpoints.md b/docs/connected_services/how_to/endpoints.md index e9eaddc..88da795 100644 --- a/docs/connected_services/how_to/endpoints.md +++ b/docs/connected_services/how_to/endpoints.md @@ -40,7 +40,7 @@ | SendFunds | :heavy_check_mark: | | VerifyPassword | :heavy_check_mark: | -### Meta endpoints +### Meta Usage endpoints | name | purpose | json input | path | HTTP Method | correct status | return type | return value | Jresp | Jreq | A | U | | :------------------ | -------------------------------------------------------------------------------------------------- | ------------------------------- | --------------------------------- | :---------: | :------------: | :---------: | :----------------------------: | :----------------: | :----------------: | :----------------------: | :----------------------: | | ChangePassword | changes 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: | @@ -48,7 +48,7 @@ | 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: | | 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 endpoint errors +### Meta Usage endpoint errors | name | 400 | 401 | 404 | 406 | | :------------------ | :----------------: | :----------------: | :----------------------: | :----------------: | | ChangePassword | :heavy_check_mark: | :heavy_check_mark: | :heavy_multiplication_x: | :heavy_check_mark: | @@ -56,10 +56,20 @@ | SetBal | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | ImpactBal | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | -### Meta endpoint support +### Meta Usage endpoint support | name | v1 | | :------------------ | :----------------: | | ChangePassword | :heavy_check_mark: | | AdminChangePassword | :heavy_check_mark: | | SetBal | :heavy_check_mark: | | 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 | help with usage of the API | `N/A` | api/v1/help | `GET` | 301 | `N/A` | `N/A` | `N/A` | `N/A` | :heavy_multiplication_x: | :heavy_multiplication_x: | + +### System Usage endpoint support +| name | v1 | +| :--- | :----------------: | +| Help | :heavy_check_mark: | \ No newline at end of file