[DEV-195] Fix php documentation (#1134)

* fix php documentation

* add descriptions to backend docs

* add missing php documentation

* correct some documentation details

server/controllers/staff/invite.php

@@ -23,7 +23,6 @@ DataValidator::with('CustomValidations', true);
  * @apiUse NO_PERMISSION
  * @apiUse INVALID_NAME
  * @apiUse INVALID_EMAIL
- * @apiUse INVALID_PASSWORD
  * @apiUse INVALID_LEVEL
  * @apiUse ALREADY_A_STAFF
  * @apiUse INVALID_DEPARTMENT

server/controllers/staff/resend-invite-staff.php

@@ -17,11 +17,7 @@ DataValidator::with('CustomValidations', true);
  * @apiParam {String} email The email of the new staff member.
  * 
  * @apiUse NO_PERMISSION
- * @apiUse INVALID_NAME
  * @apiUse INVALID_EMAIL
- * @apiUse INVALID_PASSWORD
- * @apiUse INVALID_LEVEL
- * @apiUse ALREADY_A_STAFF
  *
  * @apiSuccess {Object} data Empty object
  *

server/controllers/system/init-settings.php

@@ -19,15 +19,12 @@ DataValidator::with('CustomValidations', true);
  * @apiParam {String} registration Indicates if the registration should be enabled.
  * @apiParam {String} server-email Email from where automated emails will be sent.
  * @apiParam {String} smtp-host SMTP Server address.
- * @apiParam {String} smtp-port SMTP Server port.
  * @apiParam {String} smtp-user SMTP Authentication User.
  * @apiParam {String} smtp-pass SMTP Authentication Password.
  * @apiParam {String} allow-attachments Indicates if files can be attached to tickets and comments.
  * @apiParam {String} title Title of the support center
  * @apiParam {String} url Url of the frontend client.
  * @apiParam {Boolean} mandatory-login Indicates if the login is mandatory.
- * @apiParam {Number} default-department-id Indicates the id of the default department
- * @apiParam {Boolean} locked-department Indicates if the default department is locked or not
  * @apiUse INVALID_LANGUAGE
  * @apiUse INIT_SETTINGS_DONE
  *

server/controllers/system/stats.php

@@ -20,7 +20,6 @@ use RedBeanPHP\Facade as RedBean;
  * @apiParam {Number[]} owners The ids of the owners for the custom stats.
  * 
  * @apiUse NO_PERMISSION
- * @apiUse INVALID_PERIOD
  * @apiUse INVALID_DEPARTMENT_FILTER
  * @apiUse INVALID_DATE_RANGE_FILTER
  * @apiUse INVALID_OWNER_FILTER

server/controllers/system/test-smtp.php

@@ -14,7 +14,6 @@ use Respect\Validation\Validator as DataValidator;
  * @apiPermission any
  *
  * @apiParam {String} smtp-host Host of the SMTP server.
- * @apiParam {String} smtp-port Port of the SMTP server.
  * @apiParam {String} smtp-user User for the SMTP server.
  * @apiParam {String} smtp-pass Password for the SMTP server.
  *

server/controllers/ticket/add-custom-response.php

@@ -19,9 +19,9 @@ DataValidator::with('CustomValidations', true);
  * @apiParam {String} language Language of the response.
  *
  * @apiUse NO_PERMISSION
- * @apiUse INVALID_NAME
  * @apiUse INVALID_CONTENT
  * @apiUse INVALID_LANGUAGE
+ * @apiUse INVALID_TITLE
  *
  * @apiSuccess {Object} data Empty object
  *

server/controllers/ticket/comment.php

@@ -25,7 +25,6 @@ DataValidator::with('CustomValidations', true);
  * @apiUse NO_PERMISSION
  * @apiUse INVALID_CONTENT
  * @apiUse INVALID_TICKET
- * @apiUse INVALID_TOKEN
  * @apiUse INVALID_FILE
  *
  * @apiSuccess {Object} data Empty object

server/controllers/ticket/edit-title.php

@@ -19,7 +19,7 @@ DataValidator::with('CustomValidations', true);
  *
  * @apiUse NO_PERMISSION
  * @apiUse INVALID_TITLE
- * @apiUse INVALID_TOKEN
+ * @apiUse INVALID_TICKET
  *
  * @apiSuccess {Object} data Empty object
  *

server/controllers/ticket/get.php

@@ -15,8 +15,6 @@ DataValidator::with('CustomValidations', true);
  *
  * @apiParam {Number} ticketNumber The number of the ticket.
  *
- * @apiUse INVALID_TICKET
- * @apiUse INVALID_TOKEN
  * @apiUse NO_PERMISSION
  *
  * @apiSuccess {[Ticket](#api-Data_Structures-ObjectTicket)} data Information about the requested ticket.

server/data/ERRORS.php

@@ -203,10 +203,6 @@
  * @apiDefine SYSTEM_USER_IS_ALREADY_ENABLED
  * @apiError {String} SYSTEM_USER_IS_ALREADY_ENABLED The system user is already enabled.
  */
-/**
- * @apiDefine INVALID_PERIOD
- * @apiError {String} INVALID_PERIOD The period is invalid.
- */
 /**
  * @apiDefine NAME_ALREADY_USED
  * @apiError {String} NAME_ALREADY_USED The name is already used.
@@ -382,7 +378,6 @@ class ERRORS {
     const INVALID_BODY = 'INVALID_BODY';
     const SYSTEM_USER_IS_ALREADY_DISABLED = 'SYSTEM_USER_IS_ALREADY_DISABLED';
     const SYSTEM_USER_IS_ALREADY_ENABLED = 'SYSTEM_USER_IS_ALREADY_ENABLED';
-    const INVALID_PERIOD = 'INVALID_PERIOD';
     const NAME_ALREADY_USED = 'NAME_ALREADY_USED';
     const INVALID_FILE = 'INVALID_FILE';
     const INVALID_DEFAULT_DEPARTMENT = 'INVALID_DEFAULT_DEPARTMENT';