Skip to content

Commit 37c8b10

Browse files
authored
Update docs to have v2 at /tracking and /delays (#306)
1 parent 427141b commit 37c8b10

1 file changed

Lines changed: 13 additions & 9 deletions

File tree

src/swagger.json

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
}
4646
}
4747
},
48-
"/delays": {
48+
"/v2/delays": {
4949
"post": {
5050
"summary": "Return a list of bus delays for buses at a specific stop",
5151
"description": "Takes in a list of objects with fields routeID and trip ID and returns a list of objects with fields routeID, tripID, and delay.",
@@ -236,7 +236,7 @@
236236
}
237237
}
238238
},
239-
"/tracking": {
239+
"/v2/tracking": {
240240
"post": {
241241
"summary": "Return a list information about live bus information (to help draw buses on the map).",
242242
"produces": [
@@ -246,18 +246,18 @@
246246
{
247247
"in": "body",
248248
"name": "body",
249-
"description": "The bus information to get the live location and other relevant vehicle data from. The request body has only one field, data, which is an array of objects with the following fields: \n* routeNumber: The number of the bus route.\n* tripID: The unique trip identifier for the specific `routeNumber`.\n Ex. {\"data\": [{\"routeNumber\": integer, \"tripID\": string}]",
249+
"description": "The bus information to get the live location and other relevant vehicle data from. The request body has only one field, data, which is an array of objects with the following fields: \n* routeID: The number of the bus route. Note this corresponds to routeNumber from v2/route (v2/route has bad naming, so please stick with this in the meantime). \n* tripID: The unique trip identifier for the specific `routeID`.\n Ex. {\"data\": [{\"routeID\": integer, \"tripID\": string}]",
250250
"required": true,
251251
"schema": {
252252
"type": "array",
253253
"items": {
254254
"type": "object",
255255
"required": [
256-
"routeNumber",
256+
"routeID",
257257
"tripID"
258258
],
259259
"properties": {
260-
"routeNumber": {
260+
"routeID": {
261261
"type": "integer",
262262
"example": 10
263263
},
@@ -397,6 +397,10 @@
397397
"type": "integer",
398398
"example": 0
399399
},
400+
"lastUpdated": {
401+
"type": "integer",
402+
"example": 1599773185
403+
},
400404
"latitude": {
401405
"type": "double",
402406
"example": 42.459849543945
@@ -405,17 +409,17 @@
405409
"type": "double",
406410
"example": -76.55484845435
407411
},
408-
"routeNumber": {
412+
"routeID": {
409413
"type": "integer",
410414
"example": 77
411415
},
412416
"speed": {
413417
"type": "double",
414-
"example": 0.0
418+
"example": 9.834879875183105
415419
},
416-
"timestamp": {
420+
"vehicleID": {
417421
"type": "integer",
418-
"example": 1586033827
422+
"example": 0
419423
},
420424
"tripID": {
421425
"type": "string",

0 commit comments

Comments
 (0)