From 4d75b397665e0ca651f68fbd206467b4ecda4200 Mon Sep 17 00:00:00 2001
From: Mike Koch <mkoch227@gmail.com>
Date: Thu, 26 Nov 2015 23:07:18 -0500
Subject: [PATCH] Fix category endpoint, start work on apiDoc

---
 api/category/index.php |  4 ++--
 api/status/index.php   | 53 ++++++++++++++++++++++++++++++++++++++++++
 apidoc.json            |  7 ++++++
 3 files changed, 62 insertions(+), 2 deletions(-)
 create mode 100644 apidoc.json

diff --git a/api/category/index.php b/api/category/index.php
index d759c659..a3f498ef 100644
--- a/api/category/index.php
+++ b/api/category/index.php
@@ -1,6 +1,6 @@
 <?php
 define('IN_SCRIPT', 1);
-define('HESK_PATH', '../../../');
+define('HESK_PATH', '../../');
 define('API_PATH', '../');
 require_once(HESK_PATH . 'hesk_settings.inc.php');
 require_once(HESK_PATH . 'inc/common.inc.php');
@@ -26,4 +26,4 @@ if ($request_method == 'GET') {
     return output($results);
 }
 
-return http_response_code(405);
\ No newline at end of file
+return http_response_code(405);
diff --git a/api/status/index.php b/api/status/index.php
index e6727d84..c76a3681 100644
--- a/api/status/index.php
+++ b/api/status/index.php
@@ -13,6 +13,59 @@ hesk_dbConnect();
 // Routing
 $request_method = $_SERVER['REQUEST_METHOD'];
 
+/**
+ * @api {get} /status Retrieve a status
+ *
+ * @apiParam {Number} [id] The ID of the status
+ *
+ * @apiSuccess {Number} id ID of the status
+ * @apiSuccess {String} textColor The text color used for the status on the web interface
+ * @apiSuccess {Boolean} isNewTicketStatus This status is set when a new ticket is created
+ * @apiSuccess {Boolean} isClosed This status closes a ticket
+ * @apiSuccess {Boolean} isClosedByClient This status is set when a customer closes a ticket
+ * @apiSuccess {Boolean} isCustomerReplyStatus This status is set when a customer responds to a ticket
+ * @apiSuccess {Boolean} isStaffClosedOption This status is set when staff clicks the "close ticket" button
+ * @apiSuccess {Boolean} isStaffReopenedStatus This status is set when staff clicks the "open ticket" button
+ * @apiSuccess {Boolean} isDefaultStaffReplyStatus This status is used when staff responds to a ticket
+ * @apiSuccess {Boolean} lockedTicketStatus This status is set when staff clicks the "lock ticket" button
+ * @apiSuccess {Boolean} isAutocloseOption This status is set when a ticket is automatically closed
+ * @apiSuccess {Boolean} closable Tickets can be closed by the following:<br>
+ *     `yes`: Both customers/staff,<br>
+ *     `conly`: Only customers,<br>
+ *     `sonly`: Only staff,<br>
+ *     `no`: No one
+ * @apiSuccess {String} key The language key. This is deprecated and should not be used.
+ * @apiSuccess {Object[]} keys The language strings for each language
+ * @apiSuccess {String} keys.language The language for the status name
+ * @apiSuccess {String} keys.text The translated string of the status
+ *
+ * @apiSuccessExample {json} Success-Response:
+ *     {
+ *          "id": 0,
+ *          "textColor": "#FF0000",
+ *          "isNewTicketStatus": true,
+ *          "isClosed": false,
+ *          "isClosedByClient": false,
+ *          "isCustomerReplyStatus": false,
+ *          "isStaffClosedOption": false,
+ *          "isStaffReopenedStatus": false,
+ *          "isDefaultStaffReplyStatus": false,
+ *          "lockedTicketStatus": false,
+ *          "isAutocloseOption": false,
+ *          "closable": "yes",
+ *          "key": null,
+ *          "keys": [
+ *              {
+ *                  "language": "English",
+ *                  "text": "New"
+ *              },
+ *              {
+ *                  "language": "Español",
+ *                  "text": "Nuevo"
+ *              }
+ *          ]
+ *      }
+ */
 if ($request_method == 'GET') {
     if (isset($_GET['id'])) {
         $results = get_status($hesk_settings, $_GET['id']);
diff --git a/apidoc.json b/apidoc.json
new file mode 100644
index 00000000..083e8d79
--- /dev/null
+++ b/apidoc.json
@@ -0,0 +1,7 @@
+{
+	"name": "Mods for HESK API",
+	"version": "0.0.1",
+	"description": "Mods for HESK API",
+	"title": "Mods for HESK API",
+	"url": "https://mods-for-hesk.mkochcs.com/"
+}