From 17f5a899a08b992507b574eeb4047b1f6bfa8629 Mon Sep 17 00:00:00 2001 From: Abyss777 Date: Wed, 19 Oct 2016 18:35:28 +0500 Subject: - Filter events on server side - Use common path for templates - Filter events about geofences that user do not have access (minor security fix) - Removed unused function - Visual templates improvements --- swagger.json | 42 ------------------------------------------ 1 file changed, 42 deletions(-) (limited to 'swagger.json') diff --git a/swagger.json b/swagger.json index cd44c953a..0e19bf5a8 100644 --- a/swagger.json +++ b/swagger.json @@ -1040,48 +1040,6 @@ } } }, - "/events": { - "get": { - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "deviceId", - "in": "query", - "required": true, - "type": "integer" - }, - { - "name": "type", - "in": "query", - "required": true, - "type": "string" - }, - { - "name": "interval", - "in": "query", - "required": true, - "type": "integer" - } - ], - "responses": { - "200": { - "description": "OK", - "headers": {}, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/Event" - } - } - } - } - } - }, "/events/{id}": { "get": { "consumes": [ -- cgit v1.2.3 From c3a462df01d0b1ec4ca25414d6025bcb7c0a7ed8 Mon Sep 17 00:00:00 2001 From: Abyss777 Date: Mon, 31 Oct 2016 12:12:19 +0500 Subject: Update swagger.json with recent changes --- swagger.json | 260 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 260 insertions(+) (limited to 'swagger.json') diff --git a/swagger.json b/swagger.json index 0e19bf5a8..1fb723cd6 100644 --- a/swagger.json +++ b/swagger.json @@ -159,6 +159,38 @@ } } }, + "/devices/{id}/distance": { + "put": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "required": false, + "type": "integer" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DeviceTotalDistance" + } + } + ], + "responses": { + "204": { + "description": "No Content", + "headers": {} + } + } + } + }, "/devices/geofences": { "post": { "consumes": [ @@ -940,6 +972,12 @@ "in": "query", "required": true, "type": "integer" + }, + { + "name": "refresh", + "in": "query", + "required": false, + "type": "boolean" } ], "responses": { @@ -1300,6 +1338,156 @@ } } } + }, + "/statistics": { + "get": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "from", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "to", + "in": "query", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "headers": {}, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Statistics" + } + } + } + } + } + }, + "/attributes/aliases": { + "get": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "deviceId", + "in": "query", + "required": false, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "OK", + "headers": {}, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AttributeAlias" + } + } + } + } + }, + "post": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AttributeAlias" + } + } + ], + "responses": { + "200": { + "description": "OK", + "headers": {}, + "schema": { + "$ref": "#/definitions/AttributeAlias" + } + } + } + } + }, + "/attributes/aliases/{id}": { + "put": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "type": "integer" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AttributeAlias" + } + } + ], + "responses": { + "200": { + "description": "OK", + "headers": {}, + "schema": { + "$ref": "#/definitions/AttributeAlias" + } + } + } + }, + "delete": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "type": "integer" + } + ], + "responses": { + "204": { + "description": "No Content", + "headers": {} + } + } + } } }, "definitions": { @@ -1469,6 +1657,18 @@ "groupId": { "type": "integer" }, + "phone": { + "type": "string" + }, + "model": { + "type": "string" + }, + "contact": { + "type": "string" + }, + "category": { + "type": "string" + }, "geofenceIds": {}, "attributes": {} } @@ -1646,11 +1846,71 @@ "startAddress": { "type": "string" }, + "startLat": { + "type": "number" + }, + "startLon": { + "type": "number" + }, "endTime": { "type": "string" }, "endAddress": { "type": "string" + }, + "endLat": { + "type": "number" + }, + "endLon": { + "type": "number" + } + } + }, + "Statistics": { + "properties": { + "captureTime": { + "type": "string" + }, + "activeUsers": { + "type": "integer" + }, + "activeDevices": { + "type": "integer" + }, + "requests": { + "type": "integer" + }, + "messagesReceived": { + "type": "integer" + }, + "messagesStored": { + "type": "integer" + } + } + }, + "AttributeAlias": { + "properties": { + "id": { + "type": "integer" + }, + "deviceId": { + "type": "integer" + }, + "attribute": { + "type": "string" + }, + "alias": { + "type": "string" + } + } + }, + "DeviceTotalDistance": { + "properties": { + "deviceId": { + "type": "integer" + }, + "totalDistance": { + "type": "number" } } } -- cgit v1.2.3 From 825a751b13dbf5c27b647363477d6b21d3ab4a41 Mon Sep 17 00:00:00 2001 From: Abyss777 Date: Mon, 31 Oct 2016 12:22:41 +0500 Subject: Fix required --- swagger.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'swagger.json') diff --git a/swagger.json b/swagger.json index 1fb723cd6..f00f7dfe2 100644 --- a/swagger.json +++ b/swagger.json @@ -171,7 +171,7 @@ { "name": "id", "in": "path", - "required": false, + "required": true, "type": "integer" }, { -- cgit v1.2.3 From 9ed41321dd9617ccae4c4e338817eeff74876be9 Mon Sep 17 00:00:00 2001 From: Anton Tananaev Date: Wed, 30 Nov 2016 01:59:23 +1300 Subject: Update swagger version --- swagger.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'swagger.json') diff --git a/swagger.json b/swagger.json index f00f7dfe2..bdf23c96a 100644 --- a/swagger.json +++ b/swagger.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "3.7", + "version": "3.8", "title": "traccar" }, "host": "traccar.org", -- cgit v1.2.3 From 95c6403aefa394d1814430cdac02b9420e63a514 Mon Sep 17 00:00:00 2001 From: Sun Howwrongbum Date: Thu, 1 Dec 2016 00:52:25 +0530 Subject: Update User definition in api specs --- swagger.json | 29 +++++++++++++++++++++++++---- 1 file changed, 25 insertions(+), 4 deletions(-) (limited to 'swagger.json') diff --git a/swagger.json b/swagger.json index bdf23c96a..cdf710c30 100644 --- a/swagger.json +++ b/swagger.json @@ -1555,9 +1555,6 @@ "map": { "type": "string" }, - "language": { - "type": "string" - }, "distanceUnit": { "type": "string" }, @@ -1579,6 +1576,21 @@ "twelveHourFormat": { "type": "boolean" }, + "coordinateFormat": { + "type": "string" + }, + "disabled": { + "type": "boolean" + }, + "expirationTime": { + "type": "string" + }, + "deviceLimit": { + "type": "integer" + }, + "token": { + "type": "string" + }, "attributes": {} } }, @@ -1620,6 +1632,15 @@ "twelveHourFormat": { "type": "boolean" }, + "version": { + "type": "string" + }, + "forceSettings": { + "type": "boolean" + }, + "coordinateFormat": { + "type": "string" + }, "attributes": {} } }, @@ -1915,4 +1936,4 @@ } } } -} \ No newline at end of file +} -- cgit v1.2.3 From 1d77cf61d6e7303ea79f2cfcdedbca49e9f768fa Mon Sep 17 00:00:00 2001 From: Sun Howwrongbum Date: Sat, 3 Dec 2016 03:15:36 +0530 Subject: Update api specs with param id for /positions --- swagger.json | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'swagger.json') diff --git a/swagger.json b/swagger.json index cdf710c30..24bab6821 100644 --- a/swagger.json +++ b/swagger.json @@ -603,6 +603,13 @@ "in": "query", "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": { -- cgit v1.2.3 From d3dd330723ccadbb5cae8de9efbb67ea790c7ec8 Mon Sep 17 00:00:00 2001 From: Sun Howwrongbum Date: Sat, 3 Dec 2016 03:23:34 +0530 Subject: Add descriptions, update response for /positions - 'header' removed from response. --- swagger.json | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) (limited to 'swagger.json') 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": { -- cgit v1.2.3 From 68d1ff76de611e806e19c87374faeffb891cdcc0 Mon Sep 17 00:00:00 2001 From: Sun Howwrongbum Date: Sat, 3 Dec 2016 03:28:14 +0530 Subject: Fix incorrect entries - for /commandtypes and /users --- swagger.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'swagger.json') diff --git a/swagger.json b/swagger.json index 607294de4..25b76963c 100644 --- a/swagger.json +++ b/swagger.json @@ -766,7 +766,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/definitions/Position" + "$ref": "#/definitions/User" } } } @@ -921,7 +921,7 @@ } }, "/commandtypes": { - "post": { + "get": { "consumes": [ "application/json" ], -- cgit v1.2.3