Hawkin
/
arangodb
mirror of https://gitee.com/bigwinds/arangodb
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

fixed API description

This commit is contained in:
Jan Steemann 2014-09-26 16:44:41 +02:00
parent 578d22c95b
commit 1511d3b1c8
1 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
js/actions/api-user.js
View File

@ -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.