aboutsummaryrefslogtreecommitdiff
path: root/swagger.json
diff options
context:
space:
mode:
authorAnton Tananaev <anton.tananaev@gmail.com>2016-12-03 13:49:41 +1300
committerGitHub <noreply@github.com>2016-12-03 13:49:41 +1300
commit265cf7869c779898b2498387170204a28ff04106 (patch)
treeda87b14ab67a083293757d5d63eef26f261189d8 /swagger.json
parentcaaf1a62e66ba617ff6a4a5a456811825dc563cb (diff)
parent68d1ff76de611e806e19c87374faeffb891cdcc0 (diff)
downloadtrackermap-server-265cf7869c779898b2498387170204a28ff04106.tar.gz
trackermap-server-265cf7869c779898b2498387170204a28ff04106.tar.bz2
trackermap-server-265cf7869c779898b2498387170204a28ff04106.zip
Merge pull request #2636 from sunhoww/update_swagger
Update API specs with /positions
Diffstat (limited to 'swagger.json')
-rw-r--r--swagger.json18
1 files changed, 14 insertions, 4 deletions
diff --git a/swagger.json b/swagger.json
index cdf710c30..25b76963c 100644
--- a/swagger.json
+++ b/swagger.json
@@ -578,6 +578,8 @@
},
"/positions": {
"get": {
+ "summary" : "Fetches a list of Positions",
+ "description" : "Without any params, it returns a list of last known positions for all the user's devices",
"consumes": [
"application/json"
],
@@ -588,27 +590,35 @@
{
"name": "deviceId",
"in": "query",
- "description": "deviceId is optional, but requires the from and to parameters when used",
+ "description": "_deviceId_ is optional, but requires the _from_ and _to_ parameters when used",
"required": false,
"type": "integer"
},
{
"name": "from",
"in": "query",
+ "description": "Not required with _id_",
"required": false,
"type": "string"
},
{
"name": "to",
"in": "query",
+ "description": "Not required with _id_",
"required": false,
"type": "string"
+ }, {
+ "name" : "id",
+ "in" : "query",
+ "description" : "To fetch one or more positions. Multiple params can be passed like `id=31&id=42`",
+ "required" : false,
+ "type" : "integer",
+ "collectionFormat" : "multi"
}
],
"responses": {
"200": {
"description": "OK",
- "headers": {},
"schema": {
"type": "array",
"items": {
@@ -756,7 +766,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/definitions/Position"
+ "$ref": "#/definitions/User"
}
}
}
@@ -911,7 +921,7 @@
}
},
"/commandtypes": {
- "post": {
+ "get": {
"consumes": [
"application/json"
],