aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSun Howwrongbum <sun@adrenosapient.com>2016-12-06 02:47:28 +0530
committerSun Howwrongbum <sun@adrenosapient.com>2016-12-06 02:47:28 +0530
commita6989526efdd3d6a1af87270647ace0dc9a4c798 (patch)
tree5c6e31f70249d4e88cfd2b1fdc2dd2db0a7d6ab4
parent3776bd31240936f47e8790fbb8e1794d74feb19d (diff)
downloadtrackermap-server-a6989526efdd3d6a1af87270647ace0dc9a4c798.tar.gz
trackermap-server-a6989526efdd3d6a1af87270647ace0dc9a4c798.tar.bz2
trackermap-server-a6989526efdd3d6a1af87270647ace0dc9a4c798.zip
[swagger] Describe /devices
-rw-r--r--swagger.json16
1 files changed, 7 insertions, 9 deletions
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"
}
}
},