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

Merge branch 'devel' of github.com:triAGENS/ArangoDB into devel

This commit is contained in:
Willi Goesgens 2014-10-15 17:03:22 +02:00
parent 013db5856d 0fd685eb07
commit 43e4a4f126
2 changed files with 42 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -59,10 +59,10 @@ var users = require("org/arangodb/users");
/// ///
/// The call will return a JSON document with at least the following attributes on success: /// The call will return a JSON document with at least the following attributes on success:
/// ///
/// * *user*: The name of the user as a string. /// - *user*: The name of the user as a string.
/// * *active*: An optional flag that specifies whether the user is active. /// - *active*: An optional flag that specifies whether the user is active.
/// * *extra*: An optional JSON object with arbitrary extra data about the user. /// - *extra*: An optional JSON object with arbitrary extra data about the user.
/// * *changePassword*: An optional flag that specifies whether the user must /// - *changePassword*: An optional flag that specifies whether the user must
/// change the password or not. /// change the password or not.
/// ///
/// @RESTRETURNCODES /// @RESTRETURNCODES
@ -118,13 +118,13 @@ function get_api_user (req, res) {
/// The following data need to be passed in a JSON representation in the body /// The following data need to be passed in a JSON representation in the body
/// of the POST request: /// of the POST request:
/// ///
/// * *user*: The name of the user as a string. This is mandatory /// - *user*: The name of the user as a string. This is mandatory
/// * *passwd*: The user password as a string. If no password is specified, /// - *passwd*: The user password as a string. If no password is specified,
/// the empty string will be used /// the empty string will be used
/// * *active*: An optional flag that specifies whether the user is active. /// - *active*: An optional flag that specifies whether the user is active.
/// If not specified, this will default to true /// If not specified, this will default to true
/// * *extra*: An optional JSON object with arbitrary extra data about the user /// - *extra*: An optional JSON object with arbitrary extra data about the user
/// * *changePassword*: An optional flag that specifies whethers the user must /// - *changePassword*: An optional flag that specifies whethers the user must
/// change the password or not. If not specified, this will default to false /// change the password or not. If not specified, this will default to false
/// ///
/// If set to true, the only operations allowed are PUT /_api/user or PATCH /_api/user. /// If set to true, the only operations allowed are PUT /_api/user or PATCH /_api/user.
@ -132,8 +132,8 @@ function get_api_user (req, res) {
/// If the user can be added by the server, the server will respond with HTTP 201. /// If the user can be added by the server, the server will respond with HTTP 201.
/// In case of success, the returned JSON object has the following properties: /// In case of success, the returned JSON object has the following properties:
/// ///
/// * *error*: Boolean flag to indicate that an error occurred (false in this case) /// - *error*: Boolean flag to indicate that an error occurred (false in this case)
/// * *code*: The HTTP status code /// - *code*: The HTTP status code
/// ///
/// If the JSON representation is malformed or mandatory data is missing from the request, /// If the JSON representation is malformed or mandatory data is missing from the request,
/// the server will respond with HTTP 400. /// the server will respond with HTTP 400.
@ -141,10 +141,10 @@ function get_api_user (req, res) {
/// The body of the response will contain a JSON object with additional error details. /// The body of the response will contain a JSON object with additional error details.
/// The object has the following attributes: /// The object has the following attributes:
/// ///
/// * *error*: Boolean flag to indicate that an error occurred (true in this case) /// - *error*: Boolean flag to indicate that an error occurred (true in this case)
/// * *code*: The HTTP status code /// - *code*: The HTTP status code
/// * *errorNum*: The server error number /// - *errorNum*: The server error number
/// * *errorMessage*: A descriptive error message /// - *errorMessage*: A descriptive error message
/// ///
/// @RESTRETURNCODES /// @RESTRETURNCODES
/// ///
@ -223,20 +223,20 @@ function post_api_user (req, res) {
/// ///
/// The following data can to be passed in a JSON representation in the body of the POST request: /// The following data can to be passed in a JSON representation in the body of the POST request:
/// ///
/// * *passwd*: The user password as a string. Specifying a password is mandatory, /// - *passwd*: The user password as a string. Specifying a password is mandatory,
/// but the empty string is allowed for passwords /// but the empty string is allowed for passwords
/// * *active*: An optional flag that specifies whether the user is active. /// - *active*: An optional flag that specifies whether the user is active.
/// If not specified, this will default to true /// If not specified, this will default to true
/// * *extra*: An optional JSON object with arbitrary extra data about the user /// - *extra*: An optional JSON object with arbitrary extra data about the user
/// * *changePassword*: An optional flag that specifies whether the user must change /// - *changePassword*: An optional flag that specifies whether the user must change
/// the password or not. If not specified, this will default to false /// the password or not. If not specified, this will default to false
/// ///
/// If the user can be replaced by the server, the server will respond with HTTP 200. /// If the user can be replaced by the server, the server will respond with HTTP 200.
/// ///
/// In case of success, the returned JSON object has the following properties: /// In case of success, the returned JSON object has the following properties:
/// ///
/// * *error*: Boolean flag to indicate that an error occurred (false in this case) /// - *error*: Boolean flag to indicate that an error occurred (false in this case)
/// * *code*: The HTTP status code /// - *code*: The HTTP status code
/// ///
/// If the JSON representation is malformed or mandatory data is missing from the request, /// If the JSON representation is malformed or mandatory data is missing from the request,
/// the server will respond with HTTP 400. If the specified user does not exist, /// the server will respond with HTTP 400. If the specified user does not exist,
@ -245,10 +245,10 @@ function post_api_user (req, res) {
/// The body of the response will contain a JSON object with additional /// The body of the response will contain a JSON object with additional
/// error details. The object has the following attributes: /// error details. The object has the following attributes:
/// ///
/// * *error*: Boolean flag to indicate that an error occurred (true in this case) /// - *error*: Boolean flag to indicate that an error occurred (true in this case)
/// * *code*: The HTTP status code /// - *code*: The HTTP status code
/// * *errorNum*: The server error number /// - *errorNum*: The server error number
/// * *errorMessage*: A descriptive error message /// - *errorMessage*: A descriptive error message
/// ///
/// @RESTRETURNCODES /// @RESTRETURNCODES
/// ///
@ -318,21 +318,21 @@ function put_api_user (req, res) {
/// The following data can be passed in a JSON representation in the body of the /// The following data can be passed in a JSON representation in the body of the
/// POST request: /// POST request:
/// ///
/// * *passwd*: The user password as a string. Specifying a password is optional. /// - *passwd*: The user password as a string. Specifying a password is optional.
/// If not specified, the previously existing value will not be modified. /// If not specified, the previously existing value will not be modified.
/// * *active*: An optional flag that specifies whether the user is active. /// - *active*: An optional flag that specifies whether the user is active.
/// If not specified, the previously existing value will not be modified. /// If not specified, the previously existing value will not be modified.
/// * *extra*: An optional JSON object with arbitrary extra data about the user. /// - *extra*: An optional JSON object with arbitrary extra data about the user.
/// If not specified, the previously existing value will not be modified. /// If not specified, the previously existing value will not be modified.
/// * *changePassword*: An optional flag that specifies whether the user must change /// - *changePassword*: An optional flag that specifies whether the user must change
/// the password or not. If not specified, the previously existing value will not be modified. /// the password or not. If not specified, the previously existing value will not be modified.
/// ///
/// If the user can be updated by the server, the server will respond with HTTP 200. /// If the user can be updated by the server, the server will respond with HTTP 200.
/// ///
/// In case of success, the returned JSON object has the following properties: /// In case of success, the returned JSON object has the following properties:
/// ///
/// * *error*: Boolean flag to indicate that an error occurred (false in this case) /// - *error*: Boolean flag to indicate that an error occurred (false in this case)
/// * *code*: The HTTP status code /// - *code*: The HTTP status code
/// ///
/// If the JSON representation is malformed or mandatory data is missing from the request, /// If the JSON representation is malformed or mandatory data is missing from the request,
/// the server will respond with HTTP 400. If the specified user does not exist, /// the server will respond with HTTP 400. If the specified user does not exist,
@ -341,10 +341,10 @@ function put_api_user (req, res) {
/// The body of the response will contain a JSON object with additional error details. /// The body of the response will contain a JSON object with additional error details.
/// The object has the following attributes: /// The object has the following attributes:
/// ///
/// * *error*: Boolean flag to indicate that an error occurred (true in this case) /// - *error*: Boolean flag to indicate that an error occurred (true in this case)
/// * *code*: The HTTP status code /// - *code*: The HTTP status code
/// * *errorNum*: The server error number /// - *errorNum*: The server error number
/// * *errorMessage*: A descriptive error message /// - *errorMessage*: A descriptive error message
/// ///
/// @RESTRETURNCODES /// @RESTRETURNCODES
/// ///
@ -410,18 +410,18 @@ function patch_api_user (req, res) {
/// If the user can be removed, the server will respond with HTTP 202. /// If the user can be removed, the server will respond with HTTP 202.
/// In case of success, the returned JSON object has the following properties: /// In case of success, the returned JSON object has the following properties:
/// ///
/// * *error*: Boolean flag to indicate that an error occurred (false in this case) /// - *error*: Boolean flag to indicate that an error occurred (false in this case)
/// * *code*: The HTTP status code /// - *code*: The HTTP status code
/// ///
/// If the specified user does not exist, the server will respond with HTTP 404. /// If the specified user does not exist, the server will respond with HTTP 404.
/// ///
/// The body of the response will contain a JSON object with additional error details. /// The body of the response will contain a JSON object with additional error details.
/// The object has the following attributes: /// The object has the following attributes:
/// ///
/// * *error*: Boolean flag to indicate that an error occurred (true in this case) /// - *error*: Boolean flag to indicate that an error occurred (true in this case)
/// * *code*: The HTTP status code /// - *code*: The HTTP status code
/// * *errorNum*: The server error number /// - *errorNum*: The server error number
/// * *errorMessage*: A descriptive error message /// - *errorMessage*: A descriptive error message
/// ///
/// @RESTRETURNCODES /// @RESTRETURNCODES
/// ///

2
js/server/modules/org/arangodb/foxx/controller.js
View File

@ -428,7 +428,7 @@ extend(Controller.prototype, {
/// that it should execute around the function which normally handles the /// that it should execute around the function which normally handles the
/// route. If you do omit the path, the function will be executed before each /// route. If you do omit the path, the function will be executed before each
/// request, no matter the path. Your function gets a Request and a Response /// request, no matter the path. Your function gets a Request and a Response
/// object and a next funcion, which you must call to execute the handler for /// object and a next function, which you must call to execute the handler for
/// that route. /// that route.
/// ///
/// @EXAMPLES /// @EXAMPLES