apidoc comments in EventController

GladysAssistant · Oct 27, 2016 · ed127a0 · ed127a0
1 parent beb9e3c
commit ed127a0
Showing 1 changed file with 40 additions and 2 deletions.
diff --git a/api/controllers/EventController.js b/api/controllers/EventController.js
@@ -7,8 +7,24 @@
 
 module.exports = {
 
-    /** 
-     * Return all events from a specific user
+    /**
+     * @api {get} /event GET
+     * @apiName GetEvents
+     * @apiGroup Event
+     * @apiPermission authenticated
+     *
+     * @apiParam {Integer} [take] Number of events to return
+     * @apiParam {Integer} [skip] Where to start (for pagination)
+     *
+     * @apiSuccess {Integer} id Event id
+     * @apiSuccess {Integer} user  User id
+     * @apiSuccess {Integer} house  House id 
+     * @apiSuccess {Integer} room  Room id
+     * @apiSuccess {Integer} eventtype  Event Type id
+     * @apiSuccess {String} code  Event code
+     * @apiSuccess {String} name  Event name
+     * @apiSuccess {String} description  Event description
+     * 
      */
     index: function(req, res, next){
         req.query.user = req.session.User;
@@ -19,6 +35,28 @@ module.exports = {
           .catch(next);
     },
 
+     /**
+     * @api {post} /event POST
+     * @apiName CreateEvent
+     * @apiGroup Event
+     * @apiPermission authenticated
+     *
+     * @apiParam {String} code Event code you want to create
+     * @apiParam {Integer} [user] id of the user concerned by the event (only for user-related event)
+     * @apiParam {Integer} [house] id of the house where the events take place
+     * @apiParam {Integer} [room] id of the room where the events take place
+     * @apiParam {Datetime} [datetime] If you want to specify a specific datetime when the event took place
+     *
+     * @apiSuccess {Integer} id Event id
+     * @apiSuccess {Integer} user  User id
+     * @apiSuccess {Integer} house  House id 
+     * @apiSuccess {Integer} room  Room id
+     * @apiSuccess {Integer} eventtype  Event Type id
+     * @apiSuccess {String} code  Event code
+     * @apiSuccess {String} name  Event name
+     * @apiSuccess {String} description  Event description
+     * 
+     */
     create: function(req, res, next){
 
         // get or post request are allowed