From 6948c8ace1db450ffa885afa1285eb9491a8e772 Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Thu, 7 Aug 2014 00:36:04 -0700 Subject: [PATCH] more gatewayd reformatting --- gatewayd.md | 44 +++++++++++++++++++++++++++++++++----------- 1 file changed, 33 insertions(+), 11 deletions(-) diff --git a/gatewayd.md b/gatewayd.md index 4fd751b7f6..6c1bc93eb7 100644 --- a/gatewayd.md +++ b/gatewayd.md @@ -413,7 +413,7 @@ Response Body: ``` ### Activate User ### -[[Source
]](https://github.com/ripple/gatewayd/blob/master/lib/http/controllers/api/activate_user.js "Source") +[[Source]
](https://github.com/ripple/gatewayd/blob/master/lib/http/controllers/api/activate_user.js "Source")
*REST* @@ -433,7 +433,7 @@ $ bin/gateway activate_user 508 *Javascript* ``` -//id: string account ID +//id: integer account ID //callback: function f(err, user) to run on callback gateway.api.activateUser(id, callback) ``` @@ -469,17 +469,36 @@ Response Body: ``` ### Deactivate User ### -__`POST /v1/users/{:id}/deactivate`__ +[[Source]
](https://github.com/ripple/gatewayd/blob/master/lib/http/controllers/api/deactivate_user.js "Source") + +
+*REST* + +``` +POST /v1/users/{:id}/deactivate +{} +``` + +*Commandline* + +``` +# Syntax: deactivate user +$ bin/gateway deactivate_user 508 +``` + +*Javascript* + +``` +//id: integer account ID +//callback: function f(err, user) to run on callback +gateway.api.deactivateUser(id, callback) +``` +
+ To mark a user an "inactive", run this command with the user's ID. This flag is purely for informational purposes and is not enforced in any way. -Request Body: - -``` -{} -``` - Response Body: ``` @@ -505,6 +524,8 @@ Response Body: ``` ### Log In User ### +This method appears not to exist in the usual places in the [source code](https://github.com/ripple/gatewayd/blob/master/lib/http/routers/api_router.js) [[2]](https://github.com/ripple/gatewayd/blob/master/bin/gateway)? + __`POST /v1/users/login`__ Verifies that a user has the correct username and password combination. Used @@ -523,10 +544,11 @@ Request Body: ``` Response Body: -Not sure if res.send({ user: user }); indicates -that only the username is returned? +No example yet ### Retrieve User ### +Can't find this in the source either + __`GET /v1/users/{:id}`__ To retrieve a user's base account information, pass the user's ID to this