From a6989526efdd3d6a1af87270647ace0dc9a4c798 Mon Sep 17 00:00:00 2001
From: Sun Howwrongbum <sun@adrenosapient.com>
Date: Tue, 6 Dec 2016 02:47:28 +0530
Subject: [swagger] Describe /devices

---
 swagger.json | 16 +++++++---------
 1 file changed, 7 insertions(+), 9 deletions(-)

(limited to 'swagger.json')

diff --git a/swagger.json b/swagger.json
index 2d9e0ef3d..354544084 100644
--- a/swagger.json
+++ b/swagger.json
@@ -44,36 +44,34 @@
         },
         "/devices": {
             "get": {
-                "consumes": [
-                    "application/json"
-                ],
-                "produces": [
-                    "application/json"
-                ],
+                "summary": "Fetch a list of Devices",
+                "description": "Without any params, returns a list of the user's devices",
                 "parameters": [
                     {
                         "name": "all",
                         "in": "query",
-                        "required": true,
+                        "description": "Can only be used by admin users to fetch all entities",
                         "type": "boolean"
                     },
                     {
                         "name": "userId",
                         "in": "query",
-                        "required": true,
+                        "description": "Standard users can use this with their only with their own _userId_",
                         "type": "integer"
                     }
                 ],
                 "responses": {
                     "200": {
                         "description": "OK",
-                        "headers": {},
                         "schema": {
                             "type": "array",
                             "items": {
                                 "$ref": "#/definitions/Device"
                             }
                         }
+                    },
+                    "400": {
+                      "description": "No permission"
                     }
                 }
             },
-- 
cgit v1.2.3