Guillermo - things [skip ci]

server/controllers/article/add-topic.php

@@ -20,7 +20,8 @@ DataValidator::with('CustomValidations', true);
  * @apiUse NO_PERMISSION
  * @apiUse INVALID_NAME
  *
- * @apiSuccess {Object} data
+ * @apiSuccess {Object} data Topic info
+ * @apiSuccess {Number} data.topicId Topic id
  *
  */
 

server/controllers/article/add.php

@@ -23,8 +23,8 @@ DataValidator::with('CustomValidations', true);
  * @apiUse INVALID_CONTENT
  * @apiUse INVALID_TOPIC
  *
- * @apiSuccess {Object} data
- *
+ * @apiSuccess {Object} data Article info
+ * @apiSuccess {Number} data.articleId Article id
  */
 
 class AddArticleController extends Controller {

server/controllers/article/get-all.php

@@ -15,8 +15,7 @@ DataValidator::with('CustomValidations', true);
  *
  * @apiUse NO_PERMISSION
  * 
- * @apiSuccess {Object} data
- *
+ * @apiSuccess {[Topic](#api-Data_Structures-ObjectTopic)[]} data Array of topics.
  */
 
 class GetAllArticlesController extends Controller {

server/controllers/staff/add.php

@@ -27,7 +27,8 @@ DataValidator::with('CustomValidations', true);
  * @apiUse INVALID_LEVEL
  * @apiUse ALREADY_A_STAFF
  *
- * @apiSuccess {Object} data
+ * @apiSuccess {Object} data Staff info object
+ * @apiSuccess {Number} data.id Staff id
  *
  */
 

server/controllers/staff/get-all-tickets.php

@@ -17,7 +17,9 @@ use Respect\Validation\Validator as DataValidator;
  * @apiUse NO_PERMISSION
  * @apiUse INVALID_PAGE
  *
- * @apiSuccess {Object} data
+ * @apiSuccess {Object} data Information about a tickets and quantity of pages
+ * @apiSuccess {[Ticket](#api-Data_Structures-ObjectTicket)[]} data.tickets Array of tickets of the current page
+ * @apiSuccess {Number} data.pages Quantity of pages
  *
  */
 

server/controllers/staff/get-all.php

@@ -14,7 +14,7 @@ use Respect\Validation\Validator as DataValidator;
  * 
  * @apiUse NO_PERMISSION
  *
- * @apiSuccess {Object} data
+ * @apiSuccess {[Staff](#api-Data_Structures-ObjectStaff)[]} data Array of staff members.
  *
  */
 

server/controllers/staff/get-new-tickets.php

@@ -15,7 +15,7 @@ use Respect\Validation\Validator as DataValidator;
  *
  * @apiUse NO_PERMISSION
  * 
- * @apiSuccess {Object} data
+ * @apiSuccess {[Ticket](#api-Data_Structures-ObjectTicket)[]} data Array of new tickets
  *
  */
 

server/controllers/staff/get-tickets.php

@@ -14,7 +14,7 @@ use Respect\Validation\Validator as DataValidator;
  *
  * @apiUse NO_PERMISSION
  * 
- * @apiSuccess {Object} data
+ * @apiSuccess {[Ticket](#api-Data_Structures-ObjectTicket)[]} data Array of tickets assigned to the staff
  *
  */
 

server/controllers/staff/get.php

@@ -17,7 +17,14 @@ DataValidator::with('CustomValidations', true);
  * 
  * @apiUse NO_PERMISSION
  *
- * @apiSuccess {Object} data
+ * @apiSuccess {Object} data Information about a staff member
+ * @apiSuccess {String} data.name Staff id
+ * @apiSuccess {String} data.email Staff id
+ * @apiSuccess {String} data.profilePic Staff id
+ * @apiSuccess {Number} data.level Staff id
+ * @apiSuccess {Boolean} data.staff Staff id
+ * @apiSuccess {[Department](#api-Data_Structures-ObjectDepartment)[]} data.departments Array of departments that has assigned.
+ * @apiSuccess {[Ticket](#api-Data_Structures-ObjectTicket)[]} data.tickets Array of tickets that has assigned.
  *
  */
 

server/controllers/staff/last-events.php

@@ -17,7 +17,7 @@ use Respect\Validation\Validator as DataValidator;
  * @apiUse NO_PERMISSION
  * @apiUse INVALID_PAGE
  * 
- * @apiSuccess {Object} data
+ * @apiSuccess {[TicketEvent](#api-Data_Structures-ObjectTicketevent)[]} data Array of last events
  *
  */
 

server/controllers/staff/search-tickets.php

@@ -19,7 +19,9 @@ use Respect\Validation\Validator as DataValidator;
  * @apiUse INVALID_QUERY
  * @apiUse INVALID_PAGE
  *
- * @apiSuccess {Object} data
+ * @apiSuccess {Object} data Information about tickets
+ * @apiSuccess {[Ticket](#api-Data_Structures-ObjectTicket)[]} data.tickets Array of tickets found
+ * @apiSuccess {Number} data.pages Number of the page
  *
  */
 

server/controllers/system/add-api-key.php

@@ -18,7 +18,7 @@ use Respect\Validation\Validator as DataValidator;
  * @apiUse INVALID_NAME
  * @apiUse NAME_ALREADY_USED
  *
- * @apiSuccess {Object} data
+ * @apiSuccess {String} data Token of the api key
  *
  */
 

server/controllers/system/add-department.php

@@ -17,7 +17,7 @@ use Respect\Validation\Validator as DataValidator;
  * @apiUse NO_PERMISSION
  * @apiUse INVALID_NAME
  *
- * @apiSuccess {Object} data
+ * @apiSuccess {Object} data Empty object
  *
  */
 

server/controllers/system/backup-database.php

@@ -13,6 +13,8 @@ use Ifsnop\Mysqldump as IMysqldump;
  * @apiPermission Staff level 3
  *
  * @apiUse NO_PERMISSION
+ * 
+ * @apiSuccess {File} file File of the backup
  *
  */
 

server/controllers/system/csv-import.php

@@ -14,8 +14,9 @@
  * @apiParam {String} file A csv file with this content format: email,password, name.
  *
  * @apiUse NO_PERMISSION
+ * @apiUse INVALID_FILE
  * 
- * @apiSuccess {Object} data
+ * @apiSuccess {String[]} data Array of errors found
  *
  */
 

server/controllers/system/get-api-keys.php

@@ -14,7 +14,7 @@ use Respect\Validation\Validator as DataValidator;
  *
  * @apiUse NO_PERMISSION
  * 
- * @apiSuccess {Object} data
+ * @apiSuccess {[APIKey](#api-Data_Structures-ObjectApikey)[]} data Array of api keys
  *
  */
 

server/controllers/system/get-logs.php

@@ -17,7 +17,7 @@ use Respect\Validation\Validator as DataValidator;
  * @apiUse NO_PERMISSION
  * @apiUse INVALID_PAGE
  *
- * @apiSuccess {Object} data
+ * @apiSuccess {[Log](#api-Data_Structures-ObjectLog)[]} data Array of last logs
  *
  */
 

server/controllers/system/get-mail-templates.php

@@ -14,7 +14,7 @@ use Respect\Validation\Validator as DataValidator;
  *
  * @apiUse NO_PERMISSION
  * 
- * @apiSuccess {Object} data
+ * @apiSuccess {[MailTemplate](#api-Data_Structures-ObjectMailtemplate)[]} data Array of mail templates
  *
  */
 

server/controllers/system/get-settings.php

@@ -13,7 +13,7 @@
  *
  * @apiParam {Boolean} allSettings A bool that means if you want a regular settings list or a complety settings list.
  *
- * @apiSuccess {Object} data
+ * @apiSuccess {Object} data Contains the information about the settings
  *
  */
 

server/controllers/system/get-stats.php

@@ -18,7 +18,7 @@ use Respect\Validation\Validator as DataValidator;
  * @apiUse NO_PERMISSION
  * @apiUse INVALID_PERIOD
  *
- * @apiSuccess {Object} data
+ * @apiSuccess {[StatList](#api-Data_Structures-ObjectStatlist)[]} data Array of the stats
  *
  */
 

server/controllers/ticket/check.php

@@ -22,7 +22,9 @@ DataValidator::with('CustomValidations', true);
  * @apiUse INVALID_CAPTCHA 
  * @apiUse NO_PERMISSION
  *
- * @apiSuccess {Object} data
+ * @apiSuccess {Object} data Data for the ticket session
+ * @apiSuccess {String} data.token Token of the ticket session
+ * @apiSuccess {Number} data.ticketNumber Number of the ticket 
  *
  */
 

server/controllers/ticket/create.php

@@ -27,7 +27,8 @@ DataValidator::with('CustomValidations', true);
  * @apiUse INVALID_LANGUAGE
  * @apiUse INVALID_CAPTCHA
  *
- * @apiSuccess {Object} data
+ * @apiSuccess {Object} data Information of the new ticket
+ * @apiSuccess {Number} data.ticketNumber Number of the new ticket
  *
  */
 

server/controllers/ticket/seen.php

@@ -17,7 +17,7 @@ use Respect\Validation\Validator as DataValidator;
  * @apiUse NO_PERMISSION
  * @apiUse INVALID_TICKET
  *
- * @apiSuccess {Object} data
+ * @apiSuccess {Object} data Empty object
  *
  */
 

server/controllers/user/ban.php

@@ -18,7 +18,7 @@ use Respect\Validation\Validator as DataValidator;
  * @apiUse INVALID_EMAIL
  * @apiUse ALREADY_BANNED
  *
- * @apiSuccess {Object} data
+ * @apiSuccess {Object} data Empty object
  *
  */
 class BanUserController extends Controller {

server/controllers/user/check-session.php

@@ -7,11 +7,12 @@
  *
  * @apiGroup User
  *
- * @apiDescription This path give back a object that says if a session exist or not.
+ * @apiDescription This path retrieves a object that says if a session exist or not.
  *
  * @apiPermission Any
  *
- * @apiSuccess {Object} data
+ * @apiSuccess {Object} data Information about the session
+ * @apiSuccess {Boolean} data.sessionActive Indicate if the session is activated 
  *
  */
 

server/controllers/user/delete.php

@@ -19,7 +19,7 @@ use RedBeanPHP\Facade as RedBean;
  * @apiUse INVALID_USER
  * @apiUse USER_SYSTEM_DISABLED
  *
- * @apiSuccess {Object} data
+ * @apiSuccess {Object} data Empty object
  *
  */
 

server/controllers/user/get-user.php

@@ -19,7 +19,12 @@ DataValidator::with('CustomValidations', true);
  * @apiUse INVALID_USER
  * @apiUse USER_SYSTEM_DISABLED
  *
- * @apiSuccess {Object} data
+ * @apiSuccess {Object} data Information about a user
+ * @apiSuccess {String} data.name Name of the user
+ * @apiSuccess {String} data.email Email of the user
+ * @apiSuccess {Number} data.signupDate Date of signup of the user
+ * @apiSuccess {[Ticket](#api-Data_Structures-ObjectTicket)[]} data.tickets Array of tickets of the user
+ * @apiSuccess {Boolean} data.verified Indicates if the user is verified
  *
  */
 

server/controllers/user/get-users.php

@@ -23,7 +23,12 @@ use Respect\Validation\Validator as DataValidator;
  * @apiUse USER_SYSTEM_DISABLED
  *
  * @apiSuccess {Object} data
- *
+ * @apiSuccess {[User](#api-Data_Structures-ObjectUser)[]} data.users Array of users found
+ * @apiSuccess {Number} data.pages Number of pages found
+ * @apiSuccess {Number} data.page Number of the page
+ * @apiSuccess {String} data.orderBy Indicates if it's ordered by id or quantity of tickets
+ * @apiSuccess {Boolean} data.desc Indicates if it's ordered in decreasing order
+ * @apiSuccess {String} data.search Query of the search
  */
 
 class GetUsersController extends Controller {

server/controllers/user/get.php

@@ -16,7 +16,12 @@ DataValidator::with('CustomValidations', true);
  * @apiUse NO_PERMISSION
  * @apiUse INVALID_CREDENTIALS
  *
- * @apiSuccess {Object} data
+ * @apiSuccess {Object} data Information about a user
+ * @apiSuccess {String} data.name Name of the user 
+ * @apiSuccess {String} data.email Email of the user
+ * @apiSuccess {Boolean} data.verified Indicates if the user is verified
+ * @apiSuccess {Object} data Information about a user
+ * @apiSuccess {[Ticket](#api-Data_Structures-ObjectTicket)[]} data.tickets Array of tickets of the user
  *
  */
 

server/controllers/user/list-ban.php

@@ -14,7 +14,7 @@ use Respect\Validation\Validator as DataValidator;
  *
  * @apiUse NO_PERMISSION
  * 
- * @apiSuccess {Object} data
+ * @apiSuccess {[Ban](#api-Data_Structures-ObjectBan)[]} data Array of emails banned
  *
  */
 

server/controllers/user/login.php

@@ -23,7 +23,12 @@
  * @apiUse UNVERIFIED_USER
  * @apiUse INVALID_CREDENTIALS
  *
- * @apiSuccess {Object} data
+ * @apiSuccess {Object} data Information about the session
+ * @apiSuccess {Number} data.userId Id of the user 
+ * @apiSuccess {String} data.userEmail Email of the user
+ * @apiSuccess {Boolean} data.staff Indicates if the user is staff or not
+ * @apiSuccess {String} data.token Token of the session, used to verify the session when making other requests 
+ * @apiSuccess {String} data.rememberToken Token of the remember session for automatic login  
  *
  */
 

server/controllers/user/signup.php

@@ -28,7 +28,9 @@ DataValidator::with('CustomValidations', true);
  * @apiUse ALREADY_BANNED
  * @apiUse NO_PERMISSION
  *
- * @apiSuccess {Object} data
+ * @apiSuccess {Object} data Information about created user
+ * @apiSuccess {Number} data.userId Id of the new user
+ * @apiSuccess {String} data.userEmail Email of the new user
  *
  */
 

server/controllers/user/verify.php

@@ -19,7 +19,7 @@ use Respect\Validation\Validator as DataValidator;
  * @apiUse USER_SYSTEM_DISABLED
  * @apiUse INVALID_TOKEN
  *
- * @apiSuccess {Object} data
+ * @apiSuccess {Object} data Empty object
  *
  */
 

server/models/Department.php

@@ -6,7 +6,7 @@ use RedBeanPHP\Facade as RedBean;
  * @apiGroup Data Structures
  * @apiParam {Number} id Id of the custom response.
  * @apiParam {String} name Name of the custom response.
- * @apiParam {String} owners Owners of the department.
+ * @apiParam {[Staff](#api-Data_Structures-ObjectStaff)[]} owners Owners of the department.
  */
 
 class Department extends DataStore {

server/models/Staff.php

@@ -7,8 +7,8 @@
  * @apiParam {String} email The language of the mail template.
  * @apiParam {String} profilePic The body of the mail template.
  * @apiParam {Number} level The language of the mail template.
- * @apiParam {Object} departments The department of the staff.
- * @apiParam {Object} tickets The tickets of the staff.
+ * @apiParam {Object[]} departments The departments of the staff.
+ * @apiParam {[Ticket](#api-Data_Structures-ObjectTicket)[]} tickets The tickets of the staff.
  * @apiParam {Number} lastLogin The last login of the staff.
  */
 

server/models/Topic.php

@@ -6,7 +6,7 @@
  * @apiParam {String} name Name of the topic.
  * @apiParam {String} icon Icon of the topic.
  * @apiParam {String} iconColor Icon's color of the topic.
- * @apiParam {Object} articles Articles of the Topic.
+ * @apiParam {[Article](#api-Data_Structures-ObjectArticle)[]} articles Articles of the Topic.
  */
 
 class Topic extends DataStore {