sample-user.js

/**
 * @api {get} /user/id Request User information
 * @apiName GetUser
 * @apiGroup User
 *
 * @apiParam {Number} id Users unique ID.
 *
 * @apiSuccess {String} firstname Firstname of the User.
 * @apiSuccess {String} lastname  Lastname of the User.
 * 
 *
 * @apiSuccessExample Success-Response:
 *     HTTP/1.1 200 OK
 *     {
 *       "firstname": "John",
 *       "lastname": "Doe"
 *     }
 *
 * @apiError UserNotFound The id of the User was not found.
 *
 * @apiErrorExample Error-Response:
 *     HTTP/1.1 404 Not Found
 *     {
 *       "error": "UserNotFound"
 *     }
 */

 /**
  * @api {patch} /user/:id/:param Update User Information
  * @apiName UpdateUser
  * @apiGroup User
  * 
  * @apiParam {Number} id Users unique.
  * @apiParam {String} firstname Firstname of the User.
  * @apiParam {String} lastname Lastname of the User.
  * @apiParam {String} username Username of the User.
  * 
  * @apiSuccessExample Success-Response:
  *     HTTP/1.1 200 OK
  *     {
  *       "username": "john.doe"
  *       "firstname": "John",
  *       "lastname": "Doe"
  *     }
  * 
  * @apiError UserNotFound The id of the User was not found
  * 
  * @apiErrorExample Error-Response:
  *     HTTP/1.1 404 Not Found
  *     {
  *       "error": "UserNotFound"
  *     }
  */