From 143776febe811d6a8ad09c7c79502ccf2f9bb709 Mon Sep 17 00:00:00 2001 From: Guillermo Giuliana Date: Thu, 14 Oct 2021 17:57:02 -0300 Subject: [PATCH] update api documentation (#971) --- server/controllers/staff/get-new-tickets.php | 3 ++- server/controllers/staff/get-tickets.php | 3 ++- server/controllers/system/stats.php | 1 - server/controllers/ticket/create.php | 1 + server/controllers/ticket/search-authors.php | 3 ++- 5 files changed, 7 insertions(+), 4 deletions(-) diff --git a/server/controllers/staff/get-new-tickets.php b/server/controllers/staff/get-new-tickets.php index ca5ff728..176ec561 100755 --- a/server/controllers/staff/get-new-tickets.php +++ b/server/controllers/staff/get-new-tickets.php @@ -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 * diff --git a/server/controllers/staff/get-tickets.php b/server/controllers/staff/get-tickets.php index 5a5bb462..2ba4c3c9 100755 --- a/server/controllers/staff/get-tickets.php +++ b/server/controllers/staff/get-tickets.php @@ -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 * diff --git a/server/controllers/system/stats.php b/server/controllers/system/stats.php index 8b6170c7..67c63561 100644 --- a/server/controllers/system/stats.php +++ b/server/controllers/system/stats.php @@ -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. diff --git a/server/controllers/ticket/create.php b/server/controllers/ticket/create.php index b1df7bef..1c00aa35 100755 --- a/server/controllers/ticket/create.php +++ b/server/controllers/ticket/create.php @@ -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. diff --git a/server/controllers/ticket/search-authors.php b/server/controllers/ticket/search-authors.php index c3128b33..027a90e2 100644 --- a/server/controllers/ticket/search-authors.php +++ b/server/controllers/ticket/search-authors.php @@ -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 *