update api documentation (#971)

This commit is contained in:
Guillermo Giuliana 2021-10-14 17:57:02 -03:00 committed by GitHub
parent 6536050fdd
commit 143776febe
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 7 additions and 4 deletions

View File

@ -15,7 +15,8 @@ use Respect\Validation\Validator as DataValidator;
* @apiPermission staff1
*
* @apiParam {Number} page The page number.
*
* @apiParam {Number} departmentId The id of the department searched
*
* @apiUse NO_PERMISSION
* @apiUse INVALID_PAGE
*

View File

@ -15,7 +15,8 @@ use Respect\Validation\Validator as DataValidator;
*
* @apiParam {Number} page The page number.
* @apiParam {bool} closed Include closed tickets in the response.
*
* @apiParam {Number} departmentId The id of the department searched
*
* @apiUse NO_PERMISSION
* @apiUse INVALID_PAGE
*

View File

@ -14,7 +14,6 @@ use RedBeanPHP\Facade as RedBean;
*
* @apiPermission staff1
*
* @apiParam {Number} staffId Id of the current staff.
* @apiParam {Number[]} tags The ids of the tags for the custom stats.
* @apiParam {Number[]} dateRange The array with start and end date of the range for the custom stats.
* @apiParam {Number[]} departments The ids of the departments for the custom stats.

View File

@ -18,6 +18,7 @@ DataValidator::with('CustomValidations', true);
* @apiParam {String} content Content of the ticket.
* @apiParam {Number} departmentId The id of the department of the current ticket.
* @apiParam {String} language The language of the ticket.
* @apiParam {String} name The name of author of the ticket.
* @apiParam {String} email The email of the user who created the ticket.
* @apiParam {Number} images The number of images in the content.
* @apiParam {String} apiKey apiKey to create tickets and show ticket-number created.

View File

@ -18,7 +18,8 @@ DataValidator::with('CustomValidations', true);
*
* @apiParam {String} query A string to find into a ticket to make a custom search.
* @apiParam {Object[]} blackList A array of objects {id, isStaff} with id and boolean to eliminate the authors of the new list.
*
* @apiParam {Boolean} searchUsers A boolean that determinates if the search is for users or not
*
* @apiUse NO_PERMISSION
* @apiUse INVALID_QUERY
*