diff options
| author | Sun Howwrongbum <sun@adrenosapient.com> | 2016-12-03 03:23:34 +0530 |
|---|---|---|
| committer | Sun Howwrongbum <sun@adrenosapient.com> | 2016-12-03 03:23:34 +0530 |
| commit | d3dd330723ccadbb5cae8de9efbb67ea790c7ec8 (patch) | |
| tree | 525f56357b17c583a71125d690bd721b16d1a3ae /swagger.json | |
| parent | 1d77cf61d6e7303ea79f2cfcdedbca49e9f768fa (diff) | |
| download | trackermap-server-d3dd330723ccadbb5cae8de9efbb67ea790c7ec8.tar.gz trackermap-server-d3dd330723ccadbb5cae8de9efbb67ea790c7ec8.tar.bz2 trackermap-server-d3dd330723ccadbb5cae8de9efbb67ea790c7ec8.zip | |
Add descriptions, update response for /positions
- 'header' removed from response.
Diffstat (limited to 'swagger.json')
| -rw-r--r-- | swagger.json | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/swagger.json b/swagger.json index 24bab6821..607294de4 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,25 +590,27 @@ { "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`", + "description" : "To fetch one or more positions. Multiple params can be passed like `id=31&id=42`", "required" : false, "type" : "integer", "collectionFormat" : "multi" @@ -615,7 +619,6 @@ "responses": { "200": { "description": "OK", - "headers": {}, "schema": { "type": "array", "items": { |