From 1511d3b1c8b6ac96ce2292e605b44166736c3b8c Mon Sep 17 00:00:00 2001 From: Jan Steemann Date: Fri, 26 Sep 2014 16:44:41 +0200 Subject: [PATCH] fixed API description --- js/actions/api-user.js | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/js/actions/api-user.js b/js/actions/api-user.js index dce76d26a1..0e8a6a42c0 100644 --- a/js/actions/api-user.js +++ b/js/actions/api-user.js @@ -48,6 +48,11 @@ var users = require("org/arangodb/users"); /// /// @RESTHEADER{GET /_api/user/{user}, Fetch User} /// +/// @RESTURLPARAMETERS +/// +/// @RESTURLPARAM{user,string,optional} +/// The name of the user +/// /// @RESTDESCRIPTION /// /// Fetches data about the specified user. @@ -66,7 +71,7 @@ var users = require("org/arangodb/users"); /// The user was found /// /// @RESTRETURNCODE{404} -/// The user with user does not exist +/// The user with the specified name does not exist /// /// @endDocuBlock //////////////////////////////////////////////////////////////////////////////// @@ -207,6 +212,11 @@ function post_api_user (req, res) { /// /// @RESTHEADER{PUT /_api/user/{user}, Replace User} /// +/// @RESTURLPARAMETERS +/// +/// @RESTURLPARAM{user,string,optional} +/// The name of the user +/// /// @RESTDESCRIPTION /// /// Replaces the data of an existing user. The name of an existing user must be specified in user. @@ -295,6 +305,11 @@ function put_api_user (req, res) { /// /// @RESTHEADER{PATCH /_api/user/{user}, Update User} /// +/// @RESTURLPARAMETERS +/// +/// @RESTURLPARAM{user,string,optional} +/// The name of the user +/// /// @RESTDESCRIPTION /// /// Partially updates the data of an existing user. The name of an existing @@ -383,6 +398,11 @@ function patch_api_user (req, res) { /// /// @RESTHEADER{DELETE /_api/user/{user}, Remove User} /// +/// @RESTURLPARAMETERS +/// +/// @RESTURLPARAM{user,string,optional} +/// The name of the user +/// /// @RESTDESCRIPTION /// /// Removes an existing user, identified by user.