Skip to content

Commit 120d953

Browse files
authored
Add better route descriptions (#287)
1 parent 204dee9 commit 120d953

File tree

1 file changed

+48
-21
lines changed

1 file changed

+48
-21
lines changed

src/swagger.json

Lines changed: 48 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -57,14 +57,16 @@
5757
"in": "query",
5858
"description": "The stop you want to get the delay for",
5959
"required": true,
60-
"type": "string"
60+
"type": "string",
61+
"example": "1113"
6162
},
6263
{
6364
"name": "tripID",
6465
"in": "query",
6566
"description": "The tripID for the route",
6667
"required": true,
67-
"type": "string"
68+
"type": "string",
69+
"example": "t536-b67-slB"
6870
}
6971
],
7072
"responses": {
@@ -150,22 +152,33 @@
150152
"destinationName"
151153
],
152154
"properties": {
153-
"start": {
155+
"end": {
154156
"type": "string",
155-
"example": "25.5, 25.5"
157+
"example": "42.45322,-76.477264"
156158
},
157-
"end": {
159+
"uid": {
158160
"type": "string",
159-
"example": "25.6, 25.6"
161+
"example": "B1CD4726-0CA8-41DC-A2F4-01D5D8F3A3E0"
160162
},
161163
"time": {
162-
"type": "integer"
164+
"type": "integer",
165+
"example": 1582309886.406827
166+
},
167+
"destinationName": {
168+
"type": "string",
169+
"example": "Helen Newman Hall"
170+
},
171+
"start": {
172+
"type": "string",
173+
"example": "42.45070406588394,-76.49342862932777"
163174
},
164175
"arriveBy": {
165-
"type": "boolean"
176+
"type": "boolean",
177+
"example": false
166178
},
167-
"destinationName": {
168-
"type": "string"
179+
"originName": {
180+
"type": "string",
181+
"example": "Current Location"
169182
}
170183
}
171184
}
@@ -203,22 +216,33 @@
203216
"destinationName"
204217
],
205218
"properties": {
206-
"start": {
219+
"end": {
207220
"type": "string",
208-
"example": "25.5, 25.5"
221+
"example": "42.45322,-76.477264"
209222
},
210-
"end": {
223+
"uid": {
211224
"type": "string",
212-
"example": "25.6, 25.6"
225+
"example": "B1CD4726-0CA8-41DC-A2F4-01D5D8F3A3E0"
213226
},
214227
"time": {
215-
"type": "integer"
228+
"type": "integer",
229+
"example": 1582309886.406827
230+
},
231+
"destinationName": {
232+
"type": "string",
233+
"example": "Helen Newman Hall"
234+
},
235+
"start": {
236+
"type": "string",
237+
"example": "42.45070406588394,-76.49342862932777"
216238
},
217239
"arriveBy": {
218-
"type": "boolean"
240+
"type": "boolean",
241+
"example": false
219242
},
220-
"destinationName": {
221-
"type": "string"
243+
"originName": {
244+
"type": "string",
245+
"example": "Current Location"
222246
}
223247
}
224248
}
@@ -394,13 +418,16 @@
394418
],
395419
"properties": {
396420
"stopID": {
397-
"type": "string"
421+
"type": "string",
422+
"example": "1511"
398423
},
399424
"routeID": {
400-
"type": "integer"
425+
"type": "integer",
426+
"example": "10"
401427
},
402428
"tripIdentifiers": {
403-
"type": "string"
429+
"type": "string",
430+
"example": "t536-b67-s1B"
404431
}
405432
}
406433
}

0 commit comments

Comments
 (0)