@motis-project/motis-client 2.0.0 → 2.0.84

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (15) hide show
  1. package/README.md +11 -11
  2. package/dist/chunk-CAW6R2LI.js +1285 -0
  3. package/dist/chunk-IHFNO6R3.js +91 -0
  4. package/dist/chunk-IYBFZNEH.js +996 -865
  5. package/dist/chunk-QM2K42W7.js +62 -62
  6. package/dist/chunk-VOTN5CAZ.js +91 -0
  7. package/dist/index.d.ts +128 -3
  8. package/dist/index.js +103 -103
  9. package/dist/schemas.gen.d.ts +1047 -831
  10. package/dist/schemas.gen.js +75 -75
  11. package/dist/services.gen.d.ts +86 -18
  12. package/dist/services.gen.js +27 -27
  13. package/dist/types.gen.d.ts +1768 -1501
  14. package/dist/types.gen.js +1 -1
  15. package/package.json +2 -3
package/dist/chunk-IYBFZNEH.js CHANGED
@@ -1,270 +1,297 @@
1
1
  // openapi/schemas.gen.ts
2
2
  var AlertCauseSchema = {
3
- description: "Cause of this alert.",
4
- type: "string",
5
- enum: ["UNKNOWN_CAUSE", "OTHER_CAUSE", "TECHNICAL_PROBLEM", "STRIKE", "DEMONSTRATION", "ACCIDENT", "HOLIDAY", "WEATHER", "MAINTENANCE", "CONSTRUCTION", "POLICE_ACTIVITY", "MEDICAL_EMERGENCY"]
3
+ description: 'Cause of this alert.',
4
+ type: 'string',
5
+ enum: [
6
+ 'UNKNOWN_CAUSE',
7
+ 'OTHER_CAUSE',
8
+ 'TECHNICAL_PROBLEM',
9
+ 'STRIKE',
10
+ 'DEMONSTRATION',
11
+ 'ACCIDENT',
12
+ 'HOLIDAY',
13
+ 'WEATHER',
14
+ 'MAINTENANCE',
15
+ 'CONSTRUCTION',
16
+ 'POLICE_ACTIVITY',
17
+ 'MEDICAL_EMERGENCY'
18
+ ]
6
19
  };
7
20
  var AlertEffectSchema = {
8
- description: "The effect of this problem on the affected entity.",
9
- type: "string",
10
- enum: ["NO_SERVICE", "REDUCED_SERVICE", "SIGNIFICANT_DELAYS", "DETOUR", "ADDITIONAL_SERVICE", "MODIFIED_SERVICE", "OTHER_EFFECT", "UNKNOWN_EFFECT", "STOP_MOVED", "NO_EFFECT", "ACCESSIBILITY_ISSUE"]
21
+ description: 'The effect of this problem on the affected entity.',
22
+ type: 'string',
23
+ enum: [
24
+ 'NO_SERVICE',
25
+ 'REDUCED_SERVICE',
26
+ 'SIGNIFICANT_DELAYS',
27
+ 'DETOUR',
28
+ 'ADDITIONAL_SERVICE',
29
+ 'MODIFIED_SERVICE',
30
+ 'OTHER_EFFECT',
31
+ 'UNKNOWN_EFFECT',
32
+ 'STOP_MOVED',
33
+ 'NO_EFFECT',
34
+ 'ACCESSIBILITY_ISSUE'
35
+ ]
11
36
  };
12
37
  var AlertSeverityLevelSchema = {
13
- description: "The severity of the alert.",
14
- type: "string",
15
- enum: ["UNKNOWN_SEVERITY", "INFO", "WARNING", "SEVERE"]
38
+ description: 'The severity of the alert.',
39
+ type: 'string',
40
+ enum: ['UNKNOWN_SEVERITY', 'INFO', 'WARNING', 'SEVERE']
16
41
  };
17
42
  var TimeRangeSchema = {
18
- description: `A time interval.
43
+ description: `A time interval.
19
44
  The interval is considered active at time t if t is greater than or equal to the start time and less than the end time.
20
45
  `,
21
- type: "object",
22
- properties: {
23
- start: {
24
- description: `If missing, the interval starts at minus infinity.
46
+ type: 'object',
47
+ properties: {
48
+ start: {
49
+ description: `If missing, the interval starts at minus infinity.
25
50
  If a TimeRange is provided, either start or end must be provided - both fields cannot be empty.
26
51
  `,
27
- type: "string",
28
- format: "date-time"
29
- },
30
- end: {
31
- description: `If missing, the interval ends at plus infinity.
52
+ type: 'string',
53
+ format: 'date-time'
54
+ },
55
+ end: {
56
+ description: `If missing, the interval ends at plus infinity.
32
57
  If a TimeRange is provided, either start or end must be provided - both fields cannot be empty.
33
58
  `,
34
- type: "string",
35
- format: "date-time"
36
- }
37
- }
59
+ type: 'string',
60
+ format: 'date-time'
61
+ }
62
+ }
38
63
  };
39
64
  var AlertSchema = {
40
- description: "An alert, indicating some sort of incident in the public transit network.",
41
- type: "object",
42
- required: ["headerText", "descriptionText"],
43
- properties: {
44
- communicationPeriod: {
45
- description: `Time when the alert should be shown to the user.
65
+ description: 'An alert, indicating some sort of incident in the public transit network.',
66
+ type: 'object',
67
+ required: ['headerText', 'descriptionText'],
68
+ properties: {
69
+ communicationPeriod: {
70
+ description: `Time when the alert should be shown to the user.
46
71
  If missing, the alert will be shown as long as it appears in the feed.
47
72
  If multiple ranges are given, the alert will be shown during all of them.
48
73
  `,
49
- type: "array",
50
- items: {
51
- "$ref": "#/components/schemas/TimeRange"
52
- }
53
- },
54
- impactPeriod: {
55
- description: "Time when the services are affected by the disruption mentioned in the alert.",
56
- type: "array",
57
- items: {
58
- "$ref": "#/components/schemas/TimeRange"
59
- }
60
- },
61
- cause: {
62
- "$ref": "#/components/schemas/AlertCause"
63
- },
64
- causeDetail: {
65
- type: "string",
66
- description: `Description of the cause of the alert that allows for agency-specific language;
74
+ type: 'array',
75
+ items: {
76
+ $ref: '#/components/schemas/TimeRange'
77
+ }
78
+ },
79
+ impactPeriod: {
80
+ description: 'Time when the services are affected by the disruption mentioned in the alert.',
81
+ type: 'array',
82
+ items: {
83
+ $ref: '#/components/schemas/TimeRange'
84
+ }
85
+ },
86
+ cause: {
87
+ $ref: '#/components/schemas/AlertCause'
88
+ },
89
+ causeDetail: {
90
+ type: 'string',
91
+ description: `Description of the cause of the alert that allows for agency-specific language;
67
92
  more specific than the Cause.
68
93
  `
69
- },
70
- effect: {
71
- "$ref": "#/components/schemas/AlertEffect"
72
- },
73
- effectDetail: {
74
- type: "string",
75
- description: `Description of the effect of the alert that allows for agency-specific language;
94
+ },
95
+ effect: {
96
+ $ref: '#/components/schemas/AlertEffect'
97
+ },
98
+ effectDetail: {
99
+ type: 'string',
100
+ description: `Description of the effect of the alert that allows for agency-specific language;
76
101
  more specific than the Effect.
77
102
  `
78
- },
79
- url: {
80
- type: "string",
81
- description: "The URL which provides additional information about the alert."
82
- },
83
- headerText: {
84
- type: "string",
85
- description: `Header for the alert. This plain-text string will be highlighted, for example in boldface.
103
+ },
104
+ url: {
105
+ type: 'string',
106
+ description: 'The URL which provides additional information about the alert.'
107
+ },
108
+ headerText: {
109
+ type: 'string',
110
+ description: `Header for the alert. This plain-text string will be highlighted, for example in boldface.
86
111
  `
87
- },
88
- descriptionText: {
89
- type: "string",
90
- description: `Description for the alert.
112
+ },
113
+ descriptionText: {
114
+ type: 'string',
115
+ description: `Description for the alert.
91
116
  This plain-text string will be formatted as the body of the alert (or shown on an explicit "expand" request by the user).
92
117
  The information in the description should add to the information of the header.
93
118
  `
94
- },
95
- ttsHeaderText: {
96
- type: "string",
97
- description: `Text containing the alert's header to be used for text-to-speech implementations.
119
+ },
120
+ ttsHeaderText: {
121
+ type: 'string',
122
+ description: `Text containing the alert's header to be used for text-to-speech implementations.
98
123
  This field is the text-to-speech version of header_text.
99
124
  It should contain the same information as headerText but formatted such that it can read as text-to-speech
100
125
  (for example, abbreviations removed, numbers spelled out, etc.)
101
126
  `
102
- },
103
- ttsDescriptionText: {
104
- type: "string",
105
- description: `Text containing a description for the alert to be used for text-to-speech implementations.
127
+ },
128
+ ttsDescriptionText: {
129
+ type: 'string',
130
+ description: `Text containing a description for the alert to be used for text-to-speech implementations.
106
131
  This field is the text-to-speech version of description_text.
107
132
  It should contain the same information as description_text but formatted such that it can be read as text-to-speech
108
133
  (for example, abbreviations removed, numbers spelled out, etc.)
109
134
  `
110
- },
111
- severityLevel: {
112
- description: "Severity of the alert.",
113
- "$ref": "#/components/schemas/AlertSeverityLevel"
114
- },
115
- imageUrl: {
116
- description: "String containing an URL linking to an image.",
117
- type: "string"
118
- },
119
- imageMediaType: {
120
- description: `IANA media type as to specify the type of image to be displayed. The type must start with "image/"
135
+ },
136
+ severityLevel: {
137
+ description: 'Severity of the alert.',
138
+ $ref: '#/components/schemas/AlertSeverityLevel'
139
+ },
140
+ imageUrl: {
141
+ description: 'String containing an URL linking to an image.',
142
+ type: 'string'
143
+ },
144
+ imageMediaType: {
145
+ description: `IANA media type as to specify the type of image to be displayed. The type must start with "image/"
121
146
  `,
122
- type: "string"
123
- },
124
- imageAlternativeText: {
125
- description: `Text describing the appearance of the linked image in the image field
147
+ type: 'string'
148
+ },
149
+ imageAlternativeText: {
150
+ description: `Text describing the appearance of the linked image in the image field
126
151
  (e.g., in case the image can't be displayed or the user can't see the image for accessibility reasons).
127
152
  See the HTML spec for alt image text.
128
153
  `,
129
- type: "string"
130
- }
131
- }
154
+ type: 'string'
155
+ }
156
+ }
132
157
  };
133
158
  var DurationSchema = {
134
- description: "Object containing duration if a path was found or none if no path was found",
135
- type: "object",
136
- properties: {
137
- duration: {
138
- type: "number",
139
- description: "duration in seconds if a path was found, otherwise missing"
140
- }
141
- }
159
+ description: 'Object containing duration if a path was found or none if no path was found',
160
+ type: 'object',
161
+ properties: {
162
+ duration: {
163
+ type: 'number',
164
+ description: 'duration in seconds if a path was found, otherwise missing'
165
+ }
166
+ }
142
167
  };
143
168
  var AreaSchema = {
144
- description: "Administrative area",
145
- type: "object",
146
- required: ["name", "adminLevel", "matched"],
147
- properties: {
148
- name: {
149
- type: "string",
150
- description: "Name of the area"
151
- },
152
- adminLevel: {
153
- type: "number",
154
- description: `[OpenStreetMap \`admin_level\`](https://wiki.openstreetmap.org/wiki/Key:admin_level)
169
+ description: 'Administrative area',
170
+ type: 'object',
171
+ required: ['name', 'adminLevel', 'matched'],
172
+ properties: {
173
+ name: {
174
+ type: 'string',
175
+ description: 'Name of the area'
176
+ },
177
+ adminLevel: {
178
+ type: 'number',
179
+ description: `[OpenStreetMap \`admin_level\`](https://wiki.openstreetmap.org/wiki/Key:admin_level)
155
180
  of the area
156
181
  `
157
- },
158
- matched: {
159
- type: "boolean",
160
- description: "Whether this area was matched by the input text"
161
- },
162
- unique: {
163
- type: "boolean",
164
- description: `Set for the first area after the \`default\` area that distinguishes areas
182
+ },
183
+ matched: {
184
+ type: 'boolean',
185
+ description: 'Whether this area was matched by the input text'
186
+ },
187
+ unique: {
188
+ type: 'boolean',
189
+ description: `Set for the first area after the \`default\` area that distinguishes areas
165
190
  if the match is ambiguous regarding (\`default\` area + place name / street [+ house number]).
166
191
  `
167
- },
168
- default: {
169
- type: "boolean",
170
- description: "Whether this area should be displayed as default area (area with admin level closest 7)"
171
- }
172
- }
192
+ },
193
+ default: {
194
+ type: 'boolean',
195
+ description:
196
+ 'Whether this area should be displayed as default area (area with admin level closest 7)'
197
+ }
198
+ }
173
199
  };
174
200
  var TokenSchema = {
175
- description: "Matched token range (from index, length)",
176
- type: "array",
177
- minItems: 2,
178
- maxItems: 2,
179
- items: {
180
- type: "number"
181
- }
201
+ description: 'Matched token range (from index, length)',
202
+ type: 'array',
203
+ minItems: 2,
204
+ maxItems: 2,
205
+ items: {
206
+ type: 'number'
207
+ }
182
208
  };
183
209
  var LocationTypeSchema = {
184
- description: "location type",
185
- type: "string",
186
- enum: ["ADDRESS", "PLACE", "STOP"]
210
+ description: 'location type',
211
+ type: 'string',
212
+ enum: ['ADDRESS', 'PLACE', 'STOP']
187
213
  };
188
214
  var MatchSchema = {
189
- description: "GeoCoding match",
190
- type: "object",
191
- required: ["type", "name", "id", "lat", "lon", "tokens", "areas", "score"],
192
- properties: {
193
- type: {
194
- "$ref": "#/components/schemas/LocationType"
195
- },
196
- tokens: {
197
- description: "list of non-overlapping tokens that were matched",
198
- type: "array",
199
- items: {
200
- "$ref": "#/components/schemas/Token"
201
- }
202
- },
203
- name: {
204
- description: "name of the location (transit stop / PoI / address)",
205
- type: "string"
206
- },
207
- id: {
208
- description: "unique ID of the location",
209
- type: "string"
210
- },
211
- lat: {
212
- description: "latitude",
213
- type: "number"
214
- },
215
- lon: {
216
- description: "longitude",
217
- type: "number"
218
- },
219
- level: {
220
- description: `level according to OpenStreetMap
215
+ description: 'GeoCoding match',
216
+ type: 'object',
217
+ required: ['type', 'name', 'id', 'lat', 'lon', 'tokens', 'areas', 'score'],
218
+ properties: {
219
+ type: {
220
+ $ref: '#/components/schemas/LocationType'
221
+ },
222
+ tokens: {
223
+ description: 'list of non-overlapping tokens that were matched',
224
+ type: 'array',
225
+ items: {
226
+ $ref: '#/components/schemas/Token'
227
+ }
228
+ },
229
+ name: {
230
+ description: 'name of the location (transit stop / PoI / address)',
231
+ type: 'string'
232
+ },
233
+ id: {
234
+ description: 'unique ID of the location',
235
+ type: 'string'
236
+ },
237
+ lat: {
238
+ description: 'latitude',
239
+ type: 'number'
240
+ },
241
+ lon: {
242
+ description: 'longitude',
243
+ type: 'number'
244
+ },
245
+ level: {
246
+ description: `level according to OpenStreetMap
221
247
  (at the moment only for public transport)
222
248
  `,
223
- type: "number"
224
- },
225
- street: {
226
- description: "street name",
227
- type: "string"
228
- },
229
- houseNumber: {
230
- description: "house number",
231
- type: "string"
232
- },
233
- zip: {
234
- description: "zip code",
235
- type: "string"
236
- },
237
- areas: {
238
- description: "list of areas",
239
- type: "array",
240
- items: {
241
- "$ref": "#/components/schemas/Area"
242
- }
243
- },
244
- score: {
245
- description: "score according to the internal scoring system (the scoring algorithm might change in the future)",
246
- type: "number"
247
- }
248
- }
249
+ type: 'number'
250
+ },
251
+ street: {
252
+ description: 'street name',
253
+ type: 'string'
254
+ },
255
+ houseNumber: {
256
+ description: 'house number',
257
+ type: 'string'
258
+ },
259
+ zip: {
260
+ description: 'zip code',
261
+ type: 'string'
262
+ },
263
+ areas: {
264
+ description: 'list of areas',
265
+ type: 'array',
266
+ items: {
267
+ $ref: '#/components/schemas/Area'
268
+ }
269
+ },
270
+ score: {
271
+ description:
272
+ 'score according to the internal scoring system (the scoring algorithm might change in the future)',
273
+ type: 'number'
274
+ }
275
+ }
249
276
  };
250
277
  var ElevationCostsSchema = {
251
- description: `Different elevation cost profiles for street routing.
278
+ description: `Different elevation cost profiles for street routing.
252
279
  Using a elevation cost profile will prefer routes with a smaller incline and smaller difference in elevation, even if the routed way is longer.
253
280
 
254
281
  - \`NONE\`: Ignore elevation data for routing. This is the default behavior
255
282
  - \`LOW\`: Add a low penalty for inclines. This will favor longer paths, if the elevation increase and incline are smaller.
256
283
  - \`HIGH\`: Add a high penalty for inclines. This will favor even longer paths, if the elevation increase and incline are smaller.
257
284
  `,
258
- type: "string",
259
- enum: ["NONE", "LOW", "HIGH"]
285
+ type: 'string',
286
+ enum: ['NONE', 'LOW', 'HIGH']
260
287
  };
261
288
  var PedestrianProfileSchema = {
262
- description: "Different accessibility profiles for pedestrians.",
263
- type: "string",
264
- enum: ["FOOT", "WHEELCHAIR"]
289
+ description: 'Different accessibility profiles for pedestrians.',
290
+ type: 'string',
291
+ enum: ['FOOT', 'WHEELCHAIR']
265
292
  };
266
293
  var ModeSchema = {
267
- description: `# Street modes
294
+ description: `# Street modes
268
295
 
269
296
  - \`WALK\`
270
297
  - \`BIKE\`
@@ -290,117 +317,141 @@ var ModeSchema = {
290
317
  - \`REGIONAL_FAST_RAIL\`: regional express routes that skip low traffic stops to be faster
291
318
  - \`REGIONAL_RAIL\`: regional train
292
319
  `,
293
- type: "string",
294
- enum: ["WALK", "BIKE", "RENTAL", "CAR", "CAR_PARKING", "ODM", "TRANSIT", "TRAM", "SUBWAY", "FERRY", "AIRPLANE", "METRO", "BUS", "COACH", "RAIL", "HIGHSPEED_RAIL", "LONG_DISTANCE", "NIGHT_RAIL", "REGIONAL_FAST_RAIL", "REGIONAL_RAIL", "OTHER"]
320
+ type: 'string',
321
+ enum: [
322
+ 'WALK',
323
+ 'BIKE',
324
+ 'RENTAL',
325
+ 'CAR',
326
+ 'CAR_PARKING',
327
+ 'ODM',
328
+ 'TRANSIT',
329
+ 'TRAM',
330
+ 'SUBWAY',
331
+ 'FERRY',
332
+ 'AIRPLANE',
333
+ 'METRO',
334
+ 'BUS',
335
+ 'COACH',
336
+ 'RAIL',
337
+ 'HIGHSPEED_RAIL',
338
+ 'LONG_DISTANCE',
339
+ 'NIGHT_RAIL',
340
+ 'REGIONAL_FAST_RAIL',
341
+ 'REGIONAL_RAIL',
342
+ 'OTHER'
343
+ ]
295
344
  };
296
345
  var VertexTypeSchema = {
297
- type: "string",
298
- description: `- \`NORMAL\` - latitude / longitude coordinate or address
346
+ type: 'string',
347
+ description: `- \`NORMAL\` - latitude / longitude coordinate or address
299
348
  - \`BIKESHARE\` - bike sharing station
300
349
  - \`TRANSIT\` - transit stop
301
350
  `,
302
- enum: ["NORMAL", "BIKESHARE", "TRANSIT"]
351
+ enum: ['NORMAL', 'BIKESHARE', 'TRANSIT']
303
352
  };
304
353
  var PickupDropoffTypeSchema = {
305
- type: "string",
306
- description: `- \`NORMAL\` - entry/exit is possible normally
354
+ type: 'string',
355
+ description: `- \`NORMAL\` - entry/exit is possible normally
307
356
  - \`NOT_ALLOWED\` - entry/exit is not allowed
308
357
  `,
309
- enum: ["NORMAL", "NOT_ALLOWED"]
358
+ enum: ['NORMAL', 'NOT_ALLOWED']
310
359
  };
311
360
  var PlaceSchema = {
312
- type: "object",
313
- required: ["name", "lat", "lon", "level"],
314
- properties: {
315
- name: {
316
- description: "name of the transit stop / PoI / address",
317
- type: "string"
318
- },
319
- stopId: {
320
- description: "The ID of the stop. This is often something that users don't care about.",
321
- type: "string"
322
- },
323
- lat: {
324
- description: "latitude",
325
- type: "number"
326
- },
327
- lon: {
328
- description: "longitude",
329
- type: "number"
330
- },
331
- level: {
332
- description: "level according to OpenStreetMap",
333
- type: "number"
334
- },
335
- arrival: {
336
- description: "arrival time",
337
- type: "string",
338
- format: "date-time"
339
- },
340
- departure: {
341
- description: "departure time",
342
- type: "string",
343
- format: "date-time"
344
- },
345
- scheduledArrival: {
346
- description: "scheduled arrival time",
347
- type: "string",
348
- format: "date-time"
349
- },
350
- scheduledDeparture: {
351
- description: "scheduled departure time",
352
- type: "string",
353
- format: "date-time"
354
- },
355
- scheduledTrack: {
356
- description: "scheduled track from the static schedule timetable dataset",
357
- type: "string"
358
- },
359
- track: {
360
- description: `The current track/platform information, updated with real-time updates if available.
361
+ type: 'object',
362
+ required: ['name', 'lat', 'lon', 'level'],
363
+ properties: {
364
+ name: {
365
+ description: 'name of the transit stop / PoI / address',
366
+ type: 'string'
367
+ },
368
+ stopId: {
369
+ description: "The ID of the stop. This is often something that users don't care about.",
370
+ type: 'string'
371
+ },
372
+ lat: {
373
+ description: 'latitude',
374
+ type: 'number'
375
+ },
376
+ lon: {
377
+ description: 'longitude',
378
+ type: 'number'
379
+ },
380
+ level: {
381
+ description: 'level according to OpenStreetMap',
382
+ type: 'number'
383
+ },
384
+ arrival: {
385
+ description: 'arrival time',
386
+ type: 'string',
387
+ format: 'date-time'
388
+ },
389
+ departure: {
390
+ description: 'departure time',
391
+ type: 'string',
392
+ format: 'date-time'
393
+ },
394
+ scheduledArrival: {
395
+ description: 'scheduled arrival time',
396
+ type: 'string',
397
+ format: 'date-time'
398
+ },
399
+ scheduledDeparture: {
400
+ description: 'scheduled departure time',
401
+ type: 'string',
402
+ format: 'date-time'
403
+ },
404
+ scheduledTrack: {
405
+ description: 'scheduled track from the static schedule timetable dataset',
406
+ type: 'string'
407
+ },
408
+ track: {
409
+ description: `The current track/platform information, updated with real-time updates if available.
361
410
  Can be missing if neither real-time updates nor the schedule timetable contains track information.
362
411
  `,
363
- type: "string"
364
- },
365
- vertexType: {
366
- "$ref": "#/components/schemas/VertexType"
367
- },
368
- pickupType: {
369
- description: "Type of pickup. It could be disallowed due to schedule, skipped stops or cancellations.",
370
- "$ref": "#/components/schemas/PickupDropoffType"
371
- },
372
- dropoffType: {
373
- description: "Type of dropoff. It could be disallowed due to schedule, skipped stops or cancellations.",
374
- "$ref": "#/components/schemas/PickupDropoffType"
375
- },
376
- cancelled: {
377
- description: "Whether this stop is cancelled due to the realtime situation.",
378
- type: "boolean"
379
- },
380
- alerts: {
381
- description: "Alerts for this stop.",
382
- type: "array",
383
- items: {
384
- "$ref": "#/components/schemas/Alert"
385
- }
386
- }
387
- }
412
+ type: 'string'
413
+ },
414
+ vertexType: {
415
+ $ref: '#/components/schemas/VertexType'
416
+ },
417
+ pickupType: {
418
+ description:
419
+ 'Type of pickup. It could be disallowed due to schedule, skipped stops or cancellations.',
420
+ $ref: '#/components/schemas/PickupDropoffType'
421
+ },
422
+ dropoffType: {
423
+ description:
424
+ 'Type of dropoff. It could be disallowed due to schedule, skipped stops or cancellations.',
425
+ $ref: '#/components/schemas/PickupDropoffType'
426
+ },
427
+ cancelled: {
428
+ description: 'Whether this stop is cancelled due to the realtime situation.',
429
+ type: 'boolean'
430
+ },
431
+ alerts: {
432
+ description: 'Alerts for this stop.',
433
+ type: 'array',
434
+ items: {
435
+ $ref: '#/components/schemas/Alert'
436
+ }
437
+ }
438
+ }
388
439
  };
389
440
  var ReachablePlaceSchema = {
390
- description: "Place reachable by One-to-All",
391
- type: "object",
392
- properties: {
393
- place: {
394
- "$ref": "#/components/schemas/Place",
395
- description: "Place reached by One-to-All"
396
- },
397
- duration: {
398
- type: "integer",
399
- description: "Total travel duration"
400
- },
401
- k: {
402
- type: "integer",
403
- description: `k is the smallest number, for which a journey with the shortest duration and at most k-1 transfers exist.
441
+ description: 'Place reachable by One-to-All',
442
+ type: 'object',
443
+ properties: {
444
+ place: {
445
+ $ref: '#/components/schemas/Place',
446
+ description: 'Place reached by One-to-All'
447
+ },
448
+ duration: {
449
+ type: 'integer',
450
+ description: 'Total travel duration'
451
+ },
452
+ k: {
453
+ type: 'integer',
454
+ description: `k is the smallest number, for which a journey with the shortest duration and at most k-1 transfers exist.
404
455
  You can think of k as the number of connections used.
405
456
 
406
457
  In more detail:
@@ -409,313 +460,388 @@ k=0: No connection, e.g. for the one location
409
460
  k=1: Direct connection
410
461
  k=2: Connection with 1 transfer
411
462
  `
412
- }
413
- }
463
+ }
464
+ }
414
465
  };
415
466
  var ReachableSchema = {
416
- description: "Object containing all reachable places by One-to-All search",
417
- type: "object",
418
- properties: {
419
- one: {
420
- "$ref": "#/components/schemas/Place",
421
- description: "One location used in One-to-All search"
422
- },
423
- all: {
424
- description: "List of locations reachable by One-to-All",
425
- type: "array",
426
- items: {
427
- "$ref": "#/components/schemas/ReachablePlace"
428
- }
429
- }
430
- }
467
+ description: 'Object containing all reachable places by One-to-All search',
468
+ type: 'object',
469
+ properties: {
470
+ one: {
471
+ $ref: '#/components/schemas/Place',
472
+ description: 'One location used in One-to-All search'
473
+ },
474
+ all: {
475
+ description: 'List of locations reachable by One-to-All',
476
+ type: 'array',
477
+ items: {
478
+ $ref: '#/components/schemas/ReachablePlace'
479
+ }
480
+ }
481
+ }
431
482
  };
432
483
  var StopTimeSchema = {
433
- description: "departure or arrival event at a stop",
434
- type: "object",
435
- required: ["place", "mode", "realTime", "headsign", "agencyId", "agencyName", "agencyUrl", "tripId", "routeShortName", "pickupDropoffType", "cancelled", "source"],
436
- properties: {
437
- place: {
438
- "$ref": "#/components/schemas/Place",
439
- description: "information about the stop place and time"
440
- },
441
- mode: {
442
- "$ref": "#/components/schemas/Mode",
443
- description: "Transport mode for this leg"
444
- },
445
- realTime: {
446
- description: "Whether there is real-time data about this leg",
447
- type: "boolean"
448
- },
449
- headsign: {
450
- description: `For transit legs, the headsign of the bus or train being used.
484
+ description: 'departure or arrival event at a stop',
485
+ type: 'object',
486
+ required: [
487
+ 'place',
488
+ 'mode',
489
+ 'realTime',
490
+ 'headsign',
491
+ 'agencyId',
492
+ 'agencyName',
493
+ 'agencyUrl',
494
+ 'tripId',
495
+ 'routeShortName',
496
+ 'pickupDropoffType',
497
+ 'cancelled',
498
+ 'source'
499
+ ],
500
+ properties: {
501
+ place: {
502
+ $ref: '#/components/schemas/Place',
503
+ description: 'information about the stop place and time'
504
+ },
505
+ mode: {
506
+ $ref: '#/components/schemas/Mode',
507
+ description: 'Transport mode for this leg'
508
+ },
509
+ realTime: {
510
+ description: 'Whether there is real-time data about this leg',
511
+ type: 'boolean'
512
+ },
513
+ headsign: {
514
+ description: `For transit legs, the headsign of the bus or train being used.
451
515
  For non-transit legs, null
452
516
  `,
453
- type: "string"
454
- },
455
- agencyId: {
456
- type: "string"
457
- },
458
- agencyName: {
459
- type: "string"
460
- },
461
- agencyUrl: {
462
- type: "string"
463
- },
464
- routeColor: {
465
- type: "string"
466
- },
467
- routeTextColor: {
468
- type: "string"
469
- },
470
- tripId: {
471
- type: "string"
472
- },
473
- routeShortName: {
474
- type: "string"
475
- },
476
- pickupDropoffType: {
477
- description: "Type of pickup (for departures) or dropoff (for arrivals), may be disallowed either due to schedule, skipped stops or cancellations",
478
- "$ref": "#/components/schemas/PickupDropoffType"
479
- },
480
- cancelled: {
481
- description: "Whether the departure/arrival is cancelled due to the realtime situation.",
482
- type: "boolean"
483
- },
484
- source: {
485
- description: "Filename and line number where this trip is from",
486
- type: "string"
487
- }
488
- }
517
+ type: 'string'
518
+ },
519
+ agencyId: {
520
+ type: 'string'
521
+ },
522
+ agencyName: {
523
+ type: 'string'
524
+ },
525
+ agencyUrl: {
526
+ type: 'string'
527
+ },
528
+ routeColor: {
529
+ type: 'string'
530
+ },
531
+ routeTextColor: {
532
+ type: 'string'
533
+ },
534
+ tripId: {
535
+ type: 'string'
536
+ },
537
+ routeShortName: {
538
+ type: 'string'
539
+ },
540
+ pickupDropoffType: {
541
+ description:
542
+ 'Type of pickup (for departures) or dropoff (for arrivals), may be disallowed either due to schedule, skipped stops or cancellations',
543
+ $ref: '#/components/schemas/PickupDropoffType'
544
+ },
545
+ cancelled: {
546
+ description: 'Whether the departure/arrival is cancelled due to the realtime situation.',
547
+ type: 'boolean'
548
+ },
549
+ source: {
550
+ description: 'Filename and line number where this trip is from',
551
+ type: 'string'
552
+ }
553
+ }
489
554
  };
490
555
  var TripInfoSchema = {
491
- description: "trip id and name",
492
- type: "object",
493
- required: ["tripId", "routeShortName"],
494
- properties: {
495
- tripId: {
496
- description: "trip ID (dataset trip id prefixed with the dataset tag)",
497
- type: "string"
498
- },
499
- routeShortName: {
500
- description: "trip display name",
501
- type: "string"
502
- }
503
- }
556
+ description: 'trip id and name',
557
+ type: 'object',
558
+ required: ['tripId', 'routeShortName'],
559
+ properties: {
560
+ tripId: {
561
+ description: 'trip ID (dataset trip id prefixed with the dataset tag)',
562
+ type: 'string'
563
+ },
564
+ routeShortName: {
565
+ description: 'trip display name',
566
+ type: 'string'
567
+ }
568
+ }
504
569
  };
505
570
  var TripSegmentSchema = {
506
- description: "trip segment between two stops to show a trip on a map",
507
- type: "object",
508
- required: ["trips", "mode", "distance", "from", "to", "departure", "arrival", "scheduledArrival", "scheduledDeparture", "realTime", "polyline"],
509
- properties: {
510
- trips: {
511
- type: "array",
512
- items: {
513
- "$ref": "#/components/schemas/TripInfo"
514
- }
515
- },
516
- routeColor: {
517
- type: "string"
518
- },
519
- mode: {
520
- "$ref": "#/components/schemas/Mode",
521
- description: "Transport mode for this leg"
522
- },
523
- distance: {
524
- type: "number",
525
- description: "distance in meters"
526
- },
527
- from: {
528
- "$ref": "#/components/schemas/Place"
529
- },
530
- to: {
531
- "$ref": "#/components/schemas/Place"
532
- },
533
- departure: {
534
- description: "departure time",
535
- type: "string",
536
- format: "date-time"
537
- },
538
- arrival: {
539
- description: "arrival time",
540
- type: "string",
541
- format: "date-time"
542
- },
543
- scheduledDeparture: {
544
- description: "scheduled departure time",
545
- type: "string",
546
- format: "date-time"
547
- },
548
- scheduledArrival: {
549
- description: "scheduled arrival time",
550
- type: "string",
551
- format: "date-time"
552
- },
553
- realTime: {
554
- description: "Whether there is real-time data about this leg",
555
- type: "boolean"
556
- },
557
- polyline: {
558
- description: "Google polyline encoded coordinate sequence (with precision 5) where the trip travels on this segment.",
559
- type: "string"
560
- }
561
- }
571
+ description: 'trip segment between two stops to show a trip on a map',
572
+ type: 'object',
573
+ required: [
574
+ 'trips',
575
+ 'mode',
576
+ 'distance',
577
+ 'from',
578
+ 'to',
579
+ 'departure',
580
+ 'arrival',
581
+ 'scheduledArrival',
582
+ 'scheduledDeparture',
583
+ 'realTime',
584
+ 'polyline'
585
+ ],
586
+ properties: {
587
+ trips: {
588
+ type: 'array',
589
+ items: {
590
+ $ref: '#/components/schemas/TripInfo'
591
+ }
592
+ },
593
+ routeColor: {
594
+ type: 'string'
595
+ },
596
+ mode: {
597
+ $ref: '#/components/schemas/Mode',
598
+ description: 'Transport mode for this leg'
599
+ },
600
+ distance: {
601
+ type: 'number',
602
+ description: 'distance in meters'
603
+ },
604
+ from: {
605
+ $ref: '#/components/schemas/Place'
606
+ },
607
+ to: {
608
+ $ref: '#/components/schemas/Place'
609
+ },
610
+ departure: {
611
+ description: 'departure time',
612
+ type: 'string',
613
+ format: 'date-time'
614
+ },
615
+ arrival: {
616
+ description: 'arrival time',
617
+ type: 'string',
618
+ format: 'date-time'
619
+ },
620
+ scheduledDeparture: {
621
+ description: 'scheduled departure time',
622
+ type: 'string',
623
+ format: 'date-time'
624
+ },
625
+ scheduledArrival: {
626
+ description: 'scheduled arrival time',
627
+ type: 'string',
628
+ format: 'date-time'
629
+ },
630
+ realTime: {
631
+ description: 'Whether there is real-time data about this leg',
632
+ type: 'boolean'
633
+ },
634
+ polyline: {
635
+ description:
636
+ 'Google polyline encoded coordinate sequence (with precision 5) where the trip travels on this segment.',
637
+ type: 'string'
638
+ }
639
+ }
562
640
  };
563
641
  var DirectionSchema = {
564
- type: "string",
565
- enum: ["DEPART", "HARD_LEFT", "LEFT", "SLIGHTLY_LEFT", "CONTINUE", "SLIGHTLY_RIGHT", "RIGHT", "HARD_RIGHT", "CIRCLE_CLOCKWISE", "CIRCLE_COUNTERCLOCKWISE", "STAIRS", "ELEVATOR", "UTURN_LEFT", "UTURN_RIGHT"]
642
+ type: 'string',
643
+ enum: [
644
+ 'DEPART',
645
+ 'HARD_LEFT',
646
+ 'LEFT',
647
+ 'SLIGHTLY_LEFT',
648
+ 'CONTINUE',
649
+ 'SLIGHTLY_RIGHT',
650
+ 'RIGHT',
651
+ 'HARD_RIGHT',
652
+ 'CIRCLE_CLOCKWISE',
653
+ 'CIRCLE_COUNTERCLOCKWISE',
654
+ 'STAIRS',
655
+ 'ELEVATOR',
656
+ 'UTURN_LEFT',
657
+ 'UTURN_RIGHT'
658
+ ]
566
659
  };
567
660
  var EncodedPolylineSchema = {
568
- type: "object",
569
- required: ["points", "precision", "length"],
570
- properties: {
571
- points: {
572
- description: "The encoded points of the polyline using the Google polyline encoding.",
573
- type: "string"
574
- },
575
- precision: {
576
- description: `The precision of the returned polyline (7 for /v1, 6 for /v2)
661
+ type: 'object',
662
+ required: ['points', 'precision', 'length'],
663
+ properties: {
664
+ points: {
665
+ description: 'The encoded points of the polyline using the Google polyline encoding.',
666
+ type: 'string'
667
+ },
668
+ precision: {
669
+ description: `The precision of the returned polyline (7 for /v1, 6 for /v2)
577
670
  Be aware that with precision 7, coordinates with |longitude| > 107.37 are undefined/will overflow.
578
671
  `,
579
- type: "integer"
580
- },
581
- length: {
582
- description: "The number of points in the string",
583
- type: "integer",
584
- minimum: 0
585
- }
586
- }
672
+ type: 'integer'
673
+ },
674
+ length: {
675
+ description: 'The number of points in the string',
676
+ type: 'integer',
677
+ minimum: 0
678
+ }
679
+ }
587
680
  };
588
681
  var StepInstructionSchema = {
589
- type: "object",
590
- required: ["fromLevel", "toLevel", "polyline", "relativeDirection", "distance", "streetName", "exit", "stayOn", "area"],
591
- properties: {
592
- relativeDirection: {
593
- "$ref": "#/components/schemas/Direction"
594
- },
595
- distance: {
596
- description: "The distance in meters that this step takes.",
597
- type: "number"
598
- },
599
- fromLevel: {
600
- description: "level where this segment starts, based on OpenStreetMap data",
601
- type: "number"
602
- },
603
- toLevel: {
604
- description: "level where this segment starts, based on OpenStreetMap data",
605
- type: "number"
606
- },
607
- osmWay: {
608
- description: "OpenStreetMap way index",
609
- type: "integer"
610
- },
611
- polyline: {
612
- "$ref": "#/components/schemas/EncodedPolyline"
613
- },
614
- streetName: {
615
- description: "The name of the street.",
616
- type: "string"
617
- },
618
- exit: {
619
- description: `Not implemented!
682
+ type: 'object',
683
+ required: [
684
+ 'fromLevel',
685
+ 'toLevel',
686
+ 'polyline',
687
+ 'relativeDirection',
688
+ 'distance',
689
+ 'streetName',
690
+ 'exit',
691
+ 'stayOn',
692
+ 'area'
693
+ ],
694
+ properties: {
695
+ relativeDirection: {
696
+ $ref: '#/components/schemas/Direction'
697
+ },
698
+ distance: {
699
+ description: 'The distance in meters that this step takes.',
700
+ type: 'number'
701
+ },
702
+ fromLevel: {
703
+ description: 'level where this segment starts, based on OpenStreetMap data',
704
+ type: 'number'
705
+ },
706
+ toLevel: {
707
+ description: 'level where this segment starts, based on OpenStreetMap data',
708
+ type: 'number'
709
+ },
710
+ osmWay: {
711
+ description: 'OpenStreetMap way index',
712
+ type: 'integer'
713
+ },
714
+ polyline: {
715
+ $ref: '#/components/schemas/EncodedPolyline'
716
+ },
717
+ streetName: {
718
+ description: 'The name of the street.',
719
+ type: 'string'
720
+ },
721
+ exit: {
722
+ description: `Not implemented!
620
723
  When exiting a highway or traffic circle, the exit name/number.
621
724
  `,
622
- type: "string"
623
- },
624
- stayOn: {
625
- description: `Not implemented!
725
+ type: 'string'
726
+ },
727
+ stayOn: {
728
+ description: `Not implemented!
626
729
  Indicates whether or not a street changes direction at an intersection.
627
730
  `,
628
- type: "boolean"
629
- },
630
- area: {
631
- description: `Not implemented!
731
+ type: 'boolean'
732
+ },
733
+ area: {
734
+ description: `Not implemented!
632
735
  This step is on an open area, such as a plaza or train platform,
633
736
  and thus the directions should say something like "cross"
634
737
  `,
635
- type: "boolean"
636
- }
637
- }
738
+ type: 'boolean'
739
+ }
740
+ }
638
741
  };
639
742
  var RentalFormFactorSchema = {
640
- type: "string",
641
- enum: ["BICYCLE", "CARGO_BICYCLE", "CAR", "MOPED", "SCOOTER_STANDING", "SCOOTER_SEATED", "OTHER"]
743
+ type: 'string',
744
+ enum: ['BICYCLE', 'CARGO_BICYCLE', 'CAR', 'MOPED', 'SCOOTER_STANDING', 'SCOOTER_SEATED', 'OTHER']
642
745
  };
643
746
  var RentalPropulsionTypeSchema = {
644
- type: "string",
645
- enum: ["HUMAN", "ELECTRIC_ASSIST", "ELECTRIC", "COMBUSTION", "COMBUSTION_DIESEL", "HYBRID", "PLUG_IN_HYBRID", "HYDROGEN_FUEL_CELL"]
747
+ type: 'string',
748
+ enum: [
749
+ 'HUMAN',
750
+ 'ELECTRIC_ASSIST',
751
+ 'ELECTRIC',
752
+ 'COMBUSTION',
753
+ 'COMBUSTION_DIESEL',
754
+ 'HYBRID',
755
+ 'PLUG_IN_HYBRID',
756
+ 'HYDROGEN_FUEL_CELL'
757
+ ]
646
758
  };
647
759
  var RentalReturnConstraintSchema = {
648
- type: "string",
649
- enum: ["NONE", "ANY_STATION", "ROUNDTRIP_STATION"]
760
+ type: 'string',
761
+ enum: ['NONE', 'ANY_STATION', 'ROUNDTRIP_STATION']
650
762
  };
651
763
  var RentalSchema = {
652
- description: "Vehicle rental",
653
- type: "object",
654
- required: ["systemId"],
655
- properties: {
656
- systemId: {
657
- type: "string",
658
- description: "Vehicle share system ID"
659
- },
660
- systemName: {
661
- type: "string",
662
- description: "Vehicle share system name"
663
- },
664
- url: {
665
- type: "string",
666
- description: "URL of the vehicle share system"
667
- },
668
- stationName: {
669
- type: "string",
670
- description: "Name of the station"
671
- },
672
- fromStationName: {
673
- type: "string",
674
- description: "Name of the station where the vehicle is picked up (empty for free floating vehicles)"
675
- },
676
- toStationName: {
677
- type: "string",
678
- description: "Name of the station where the vehicle is returned (empty for free floating vehicles)"
679
- },
680
- rentalUriAndroid: {
681
- type: "string",
682
- description: "Rental URI for Android (deep link to the specific station or vehicle)"
683
- },
684
- rentalUriIOS: {
685
- type: "string",
686
- description: "Rental URI for iOS (deep link to the specific station or vehicle)"
687
- },
688
- rentalUriWeb: {
689
- type: "string",
690
- description: "Rental URI for web (deep link to the specific station or vehicle)"
691
- },
692
- formFactor: {
693
- "$ref": "#/components/schemas/RentalFormFactor"
694
- },
695
- propulsionType: {
696
- "$ref": "#/components/schemas/RentalPropulsionType"
697
- },
698
- returnConstraint: {
699
- "$ref": "#/components/schemas/RentalReturnConstraint"
700
- }
701
- }
764
+ description: 'Vehicle rental',
765
+ type: 'object',
766
+ required: ['systemId'],
767
+ properties: {
768
+ systemId: {
769
+ type: 'string',
770
+ description: 'Vehicle share system ID'
771
+ },
772
+ systemName: {
773
+ type: 'string',
774
+ description: 'Vehicle share system name'
775
+ },
776
+ url: {
777
+ type: 'string',
778
+ description: 'URL of the vehicle share system'
779
+ },
780
+ stationName: {
781
+ type: 'string',
782
+ description: 'Name of the station'
783
+ },
784
+ fromStationName: {
785
+ type: 'string',
786
+ description:
787
+ 'Name of the station where the vehicle is picked up (empty for free floating vehicles)'
788
+ },
789
+ toStationName: {
790
+ type: 'string',
791
+ description:
792
+ 'Name of the station where the vehicle is returned (empty for free floating vehicles)'
793
+ },
794
+ rentalUriAndroid: {
795
+ type: 'string',
796
+ description: 'Rental URI for Android (deep link to the specific station or vehicle)'
797
+ },
798
+ rentalUriIOS: {
799
+ type: 'string',
800
+ description: 'Rental URI for iOS (deep link to the specific station or vehicle)'
801
+ },
802
+ rentalUriWeb: {
803
+ type: 'string',
804
+ description: 'Rental URI for web (deep link to the specific station or vehicle)'
805
+ },
806
+ formFactor: {
807
+ $ref: '#/components/schemas/RentalFormFactor'
808
+ },
809
+ propulsionType: {
810
+ $ref: '#/components/schemas/RentalPropulsionType'
811
+ },
812
+ returnConstraint: {
813
+ $ref: '#/components/schemas/RentalReturnConstraint'
814
+ }
815
+ }
702
816
  };
703
817
  var LegSchema = {
704
- type: "object",
705
- required: ["mode", "startTime", "endTime", "scheduledStartTime", "scheduledEndTime", "realTime", "scheduled", "duration", "from", "to", "legGeometry"],
706
- properties: {
707
- mode: {
708
- "$ref": "#/components/schemas/Mode",
709
- description: "Transport mode for this leg"
710
- },
711
- from: {
712
- "$ref": "#/components/schemas/Place"
713
- },
714
- to: {
715
- "$ref": "#/components/schemas/Place"
716
- },
717
- duration: {
718
- description: `Leg duration in seconds
818
+ type: 'object',
819
+ required: [
820
+ 'mode',
821
+ 'startTime',
822
+ 'endTime',
823
+ 'scheduledStartTime',
824
+ 'scheduledEndTime',
825
+ 'realTime',
826
+ 'scheduled',
827
+ 'duration',
828
+ 'from',
829
+ 'to',
830
+ 'legGeometry'
831
+ ],
832
+ properties: {
833
+ mode: {
834
+ $ref: '#/components/schemas/Mode',
835
+ description: 'Transport mode for this leg'
836
+ },
837
+ from: {
838
+ $ref: '#/components/schemas/Place'
839
+ },
840
+ to: {
841
+ $ref: '#/components/schemas/Place'
842
+ },
843
+ duration: {
844
+ description: `Leg duration in seconds
719
845
 
720
846
  If leg is footpath:
721
847
  The footpath duration is derived from the default footpath
@@ -728,203 +854,208 @@ If leg is footpath:
728
854
  \`additionalTransferTime = 0\` in case they are not explicitly
729
855
  provided in the query.
730
856
  `,
731
- type: "integer"
732
- },
733
- startTime: {
734
- type: "string",
735
- format: "date-time",
736
- description: "leg departure time"
737
- },
738
- endTime: {
739
- type: "string",
740
- format: "date-time",
741
- description: "leg arrival time"
742
- },
743
- scheduledStartTime: {
744
- type: "string",
745
- format: "date-time",
746
- description: "scheduled leg departure time"
747
- },
748
- scheduledEndTime: {
749
- type: "string",
750
- format: "date-time",
751
- description: "scheduled leg arrival time"
752
- },
753
- realTime: {
754
- description: "Whether there is real-time data about this leg",
755
- type: "boolean"
756
- },
757
- scheduled: {
758
- description: `Whether this leg was originally scheduled to run or is an additional service.
857
+ type: 'integer'
858
+ },
859
+ startTime: {
860
+ type: 'string',
861
+ format: 'date-time',
862
+ description: 'leg departure time'
863
+ },
864
+ endTime: {
865
+ type: 'string',
866
+ format: 'date-time',
867
+ description: 'leg arrival time'
868
+ },
869
+ scheduledStartTime: {
870
+ type: 'string',
871
+ format: 'date-time',
872
+ description: 'scheduled leg departure time'
873
+ },
874
+ scheduledEndTime: {
875
+ type: 'string',
876
+ format: 'date-time',
877
+ description: 'scheduled leg arrival time'
878
+ },
879
+ realTime: {
880
+ description: 'Whether there is real-time data about this leg',
881
+ type: 'boolean'
882
+ },
883
+ scheduled: {
884
+ description: `Whether this leg was originally scheduled to run or is an additional service.
759
885
  Scheduled times will equal realtime times in this case.
760
886
  `,
761
- type: "boolean"
762
- },
763
- distance: {
764
- description: "For non-transit legs the distance traveled while traversing this leg in meters.",
765
- type: "number"
766
- },
767
- interlineWithPreviousLeg: {
768
- description: "For transit legs, if the rider should stay on the vehicle as it changes route names.",
769
- type: "boolean"
770
- },
771
- headsign: {
772
- description: `For transit legs, the headsign of the bus or train being used.
887
+ type: 'boolean'
888
+ },
889
+ distance: {
890
+ description:
891
+ 'For non-transit legs the distance traveled while traversing this leg in meters.',
892
+ type: 'number'
893
+ },
894
+ interlineWithPreviousLeg: {
895
+ description:
896
+ 'For transit legs, if the rider should stay on the vehicle as it changes route names.',
897
+ type: 'boolean'
898
+ },
899
+ headsign: {
900
+ description: `For transit legs, the headsign of the bus or train being used.
773
901
  For non-transit legs, null
774
902
  `,
775
- type: "string"
776
- },
777
- routeColor: {
778
- type: "string"
779
- },
780
- routeTextColor: {
781
- type: "string"
782
- },
783
- routeType: {
784
- type: "string"
785
- },
786
- agencyName: {
787
- type: "string"
788
- },
789
- agencyUrl: {
790
- type: "string"
791
- },
792
- agencyId: {
793
- type: "string"
794
- },
795
- tripId: {
796
- type: "string"
797
- },
798
- routeShortName: {
799
- type: "string"
800
- },
801
- cancelled: {
802
- description: "Whether this trip is cancelled",
803
- type: "boolean"
804
- },
805
- source: {
806
- description: "Filename and line number where this trip is from",
807
- type: "string"
808
- },
809
- intermediateStops: {
810
- description: `For transit legs, intermediate stops between the Place where the leg originates
903
+ type: 'string'
904
+ },
905
+ routeColor: {
906
+ type: 'string'
907
+ },
908
+ routeTextColor: {
909
+ type: 'string'
910
+ },
911
+ routeType: {
912
+ type: 'string'
913
+ },
914
+ agencyName: {
915
+ type: 'string'
916
+ },
917
+ agencyUrl: {
918
+ type: 'string'
919
+ },
920
+ agencyId: {
921
+ type: 'string'
922
+ },
923
+ tripId: {
924
+ type: 'string'
925
+ },
926
+ routeShortName: {
927
+ type: 'string'
928
+ },
929
+ cancelled: {
930
+ description: 'Whether this trip is cancelled',
931
+ type: 'boolean'
932
+ },
933
+ source: {
934
+ description: 'Filename and line number where this trip is from',
935
+ type: 'string'
936
+ },
937
+ intermediateStops: {
938
+ description: `For transit legs, intermediate stops between the Place where the leg originates
811
939
  and the Place where the leg ends. For non-transit legs, null.
812
940
  `,
813
- type: "array",
814
- items: {
815
- "$ref": "#/components/schemas/Place"
816
- }
817
- },
818
- legGeometry: {
819
- "$ref": "#/components/schemas/EncodedPolyline"
820
- },
821
- steps: {
822
- description: `A series of turn by turn instructions
941
+ type: 'array',
942
+ items: {
943
+ $ref: '#/components/schemas/Place'
944
+ }
945
+ },
946
+ legGeometry: {
947
+ $ref: '#/components/schemas/EncodedPolyline'
948
+ },
949
+ steps: {
950
+ description: `A series of turn by turn instructions
823
951
  used for walking, biking and driving.
824
952
  `,
825
- type: "array",
826
- items: {
827
- "$ref": "#/components/schemas/StepInstruction"
828
- }
829
- },
830
- rental: {
831
- "$ref": "#/components/schemas/Rental"
832
- },
833
- fareTransferIndex: {
834
- type: "integer",
835
- description: `Index into \`Itinerary.fareTransfers\` array
953
+ type: 'array',
954
+ items: {
955
+ $ref: '#/components/schemas/StepInstruction'
956
+ }
957
+ },
958
+ rental: {
959
+ $ref: '#/components/schemas/Rental'
960
+ },
961
+ fareTransferIndex: {
962
+ type: 'integer',
963
+ description: `Index into \`Itinerary.fareTransfers\` array
836
964
  to identify which fare transfer this leg belongs to
837
965
  `
838
- },
839
- effectiveFareLegIndex: {
840
- type: "integer",
841
- description: `Index into the \`Itinerary.fareTransfers[fareTransferIndex].effectiveFareLegProducts\` array
966
+ },
967
+ effectiveFareLegIndex: {
968
+ type: 'integer',
969
+ description: `Index into the \`Itinerary.fareTransfers[fareTransferIndex].effectiveFareLegProducts\` array
842
970
  to identify which effective fare leg this itinerary leg belongs to
843
971
  `
844
- },
845
- alerts: {
846
- description: "Alerts for this stop.",
847
- type: "array",
848
- items: {
849
- "$ref": "#/components/schemas/Alert"
850
- }
851
- }
852
- }
972
+ },
973
+ alerts: {
974
+ description: 'Alerts for this stop.',
975
+ type: 'array',
976
+ items: {
977
+ $ref: '#/components/schemas/Alert'
978
+ }
979
+ }
980
+ }
853
981
  };
854
982
  var RiderCategorySchema = {
855
- type: "object",
856
- required: ["riderCategoryName", "isDefaultFareCategory"],
857
- properties: {
858
- riderCategoryName: {
859
- description: "Rider category name as displayed to the rider.",
860
- type: "string"
861
- },
862
- isDefaultFareCategory: {
863
- description: "Specifies if this category should be considered the default (i.e. the main category displayed to riders).",
864
- type: "boolean"
865
- },
866
- eligibilityUrl: {
867
- description: "URL to a web page providing detailed information about the rider category and/or its eligibility criteria.",
868
- type: "string"
869
- }
870
- }
983
+ type: 'object',
984
+ required: ['riderCategoryName', 'isDefaultFareCategory'],
985
+ properties: {
986
+ riderCategoryName: {
987
+ description: 'Rider category name as displayed to the rider.',
988
+ type: 'string'
989
+ },
990
+ isDefaultFareCategory: {
991
+ description:
992
+ 'Specifies if this category should be considered the default (i.e. the main category displayed to riders).',
993
+ type: 'boolean'
994
+ },
995
+ eligibilityUrl: {
996
+ description:
997
+ 'URL to a web page providing detailed information about the rider category and/or its eligibility criteria.',
998
+ type: 'string'
999
+ }
1000
+ }
871
1001
  };
872
1002
  var FareMediaTypeSchema = {
873
- type: "string",
874
- enum: ["NONE", "PAPER_TICKET", "TRANSIT_CARD", "CONTACTLESS_EMV", "MOBILE_APP"],
875
- enumDescriptions: {
876
- NONE: "No fare media involved (e.g., cash payment)",
877
- PAPER_TICKET: "Physical paper ticket",
878
- TRANSIT_CARD: "Physical transit card with stored value",
879
- CONTACTLESS_EMV: "cEMV (contactless payment)",
880
- MOBILE_APP: "Mobile app with virtual transit cards/passes"
881
- }
1003
+ type: 'string',
1004
+ enum: ['NONE', 'PAPER_TICKET', 'TRANSIT_CARD', 'CONTACTLESS_EMV', 'MOBILE_APP'],
1005
+ enumDescriptions: {
1006
+ NONE: 'No fare media involved (e.g., cash payment)',
1007
+ PAPER_TICKET: 'Physical paper ticket',
1008
+ TRANSIT_CARD: 'Physical transit card with stored value',
1009
+ CONTACTLESS_EMV: 'cEMV (contactless payment)',
1010
+ MOBILE_APP: 'Mobile app with virtual transit cards/passes'
1011
+ }
882
1012
  };
883
1013
  var FareMediaSchema = {
884
- type: "object",
885
- required: ["fareMediaType"],
886
- properties: {
887
- fareMediaName: {
888
- description: "Name of the fare media. Required for transit cards and mobile apps.",
889
- type: "string"
890
- },
891
- fareMediaType: {
892
- description: "The type of fare media.",
893
- "$ref": "#/components/schemas/FareMediaType"
894
- }
895
- }
1014
+ type: 'object',
1015
+ required: ['fareMediaType'],
1016
+ properties: {
1017
+ fareMediaName: {
1018
+ description: 'Name of the fare media. Required for transit cards and mobile apps.',
1019
+ type: 'string'
1020
+ },
1021
+ fareMediaType: {
1022
+ description: 'The type of fare media.',
1023
+ $ref: '#/components/schemas/FareMediaType'
1024
+ }
1025
+ }
896
1026
  };
897
1027
  var FareProductSchema = {
898
- type: "object",
899
- required: ["name", "amount", "currency"],
900
- properties: {
901
- name: {
902
- description: "The name of the fare product as displayed to riders.",
903
- type: "string"
904
- },
905
- amount: {
906
- description: "The cost of the fare product. May be negative to represent transfer discounts. May be zero to represent a fare product that is free.",
907
- type: "number"
908
- },
909
- currency: {
910
- description: "ISO 4217 currency code. The currency of the cost of the fare product.",
911
- type: "string"
912
- },
913
- riderCategory: {
914
- "$ref": "#/components/schemas/RiderCategory"
915
- },
916
- media: {
917
- "$ref": "#/components/schemas/FareMedia"
918
- }
919
- }
1028
+ type: 'object',
1029
+ required: ['name', 'amount', 'currency'],
1030
+ properties: {
1031
+ name: {
1032
+ description: 'The name of the fare product as displayed to riders.',
1033
+ type: 'string'
1034
+ },
1035
+ amount: {
1036
+ description:
1037
+ 'The cost of the fare product. May be negative to represent transfer discounts. May be zero to represent a fare product that is free.',
1038
+ type: 'number'
1039
+ },
1040
+ currency: {
1041
+ description: 'ISO 4217 currency code. The currency of the cost of the fare product.',
1042
+ type: 'string'
1043
+ },
1044
+ riderCategory: {
1045
+ $ref: '#/components/schemas/RiderCategory'
1046
+ },
1047
+ media: {
1048
+ $ref: '#/components/schemas/FareMedia'
1049
+ }
1050
+ }
920
1051
  };
921
1052
  var FareTransferRuleSchema = {
922
- type: "string",
923
- enum: ["A_AB", "A_AB_B", "AB"]
1053
+ type: 'string',
1054
+ enum: ['A_AB', 'A_AB_B', 'AB']
924
1055
  };
925
1056
  var FareTransferSchema = {
926
- type: "object",
927
- description: `The concept is derived from: https://gtfs.org/documentation/schedule/reference/#fare_transfer_rulestxt
1057
+ type: 'object',
1058
+ description: `The concept is derived from: https://gtfs.org/documentation/schedule/reference/#fare_transfer_rulestxt
928
1059
 
929
1060
  Terminology:
930
1061
  - **Leg**: An itinerary leg as described by the \`Leg\` type of this API description.
@@ -941,153 +1072,153 @@ The fare transfer rule is used to derive the final set of products of the itiner
941
1072
 
942
1073
  An itinerary \`Leg\` references the index of the fare transfer and the index of the effective fare leg in this transfer it belongs to.
943
1074
  `,
944
- required: ["effectiveFareLegProducts"],
945
- properties: {
946
- rule: {
947
- "$ref": "#/components/schemas/FareTransferRule"
948
- },
949
- transferProduct: {
950
- "$ref": "#/components/schemas/FareProduct"
951
- },
952
- effectiveFareLegProducts: {
953
- description: `Lists all valid fare products for the effective fare legs.
1075
+ required: ['effectiveFareLegProducts'],
1076
+ properties: {
1077
+ rule: {
1078
+ $ref: '#/components/schemas/FareTransferRule'
1079
+ },
1080
+ transferProduct: {
1081
+ $ref: '#/components/schemas/FareProduct'
1082
+ },
1083
+ effectiveFareLegProducts: {
1084
+ description: `Lists all valid fare products for the effective fare legs.
954
1085
  This is an \`array<array<FareProduct>>\` where the inner array
955
1086
  lists all possible fare products that would cover this effective fare leg.
956
1087
  Each "effective fare leg" can have multiple options for adult/child/weekly/monthly/day/one-way tickets etc.
957
1088
  You can see the outer array as AND (you need one ticket for each effective fare leg (\`A_AB_B\`), the first effective fare leg (\`A_AB\`) or no fare leg at all but only the transfer product (\`AB\`)
958
1089
  and the inner array as OR (you can choose which ticket to buy)
959
1090
  `,
960
- type: "array",
961
- items: {
962
- type: "array",
963
- items: {
964
- "$ref": "#/components/schemas/FareProduct"
965
- }
966
- }
967
- }
968
- }
1091
+ type: 'array',
1092
+ items: {
1093
+ type: 'array',
1094
+ items: {
1095
+ $ref: '#/components/schemas/FareProduct'
1096
+ }
1097
+ }
1098
+ }
1099
+ }
969
1100
  };
970
1101
  var ItinerarySchema = {
971
- type: "object",
972
- required: ["duration", "startTime", "endTime", "transfers", "legs"],
973
- properties: {
974
- duration: {
975
- description: "journey duration in seconds",
976
- type: "integer"
977
- },
978
- startTime: {
979
- type: "string",
980
- format: "date-time",
981
- description: "journey departure time"
982
- },
983
- endTime: {
984
- type: "string",
985
- format: "date-time",
986
- description: "journey arrival time"
987
- },
988
- transfers: {
989
- type: "integer",
990
- description: "The number of transfers this trip has."
991
- },
992
- legs: {
993
- description: "Journey legs",
994
- type: "array",
995
- items: {
996
- "$ref": "#/components/schemas/Leg"
997
- }
998
- },
999
- fareTransfers: {
1000
- description: "Fare information",
1001
- type: "array",
1002
- items: {
1003
- "$ref": "#/components/schemas/FareTransfer"
1004
- }
1005
- }
1006
- }
1102
+ type: 'object',
1103
+ required: ['duration', 'startTime', 'endTime', 'transfers', 'legs'],
1104
+ properties: {
1105
+ duration: {
1106
+ description: 'journey duration in seconds',
1107
+ type: 'integer'
1108
+ },
1109
+ startTime: {
1110
+ type: 'string',
1111
+ format: 'date-time',
1112
+ description: 'journey departure time'
1113
+ },
1114
+ endTime: {
1115
+ type: 'string',
1116
+ format: 'date-time',
1117
+ description: 'journey arrival time'
1118
+ },
1119
+ transfers: {
1120
+ type: 'integer',
1121
+ description: 'The number of transfers this trip has.'
1122
+ },
1123
+ legs: {
1124
+ description: 'Journey legs',
1125
+ type: 'array',
1126
+ items: {
1127
+ $ref: '#/components/schemas/Leg'
1128
+ }
1129
+ },
1130
+ fareTransfers: {
1131
+ description: 'Fare information',
1132
+ type: 'array',
1133
+ items: {
1134
+ $ref: '#/components/schemas/FareTransfer'
1135
+ }
1136
+ }
1137
+ }
1007
1138
  };
1008
1139
  var FootpathSchema = {
1009
- description: "footpath from one location to another",
1010
- type: "object",
1011
- required: ["to"],
1012
- properties: {
1013
- to: {
1014
- "$ref": "#/components/schemas/Place"
1015
- },
1016
- default: {
1017
- type: "number",
1018
- description: `optional; missing if the GTFS did not contain a footpath
1140
+ description: 'footpath from one location to another',
1141
+ type: 'object',
1142
+ required: ['to'],
1143
+ properties: {
1144
+ to: {
1145
+ $ref: '#/components/schemas/Place'
1146
+ },
1147
+ default: {
1148
+ type: 'number',
1149
+ description: `optional; missing if the GTFS did not contain a footpath
1019
1150
  footpath duration in minutes according to GTFS (+heuristics)
1020
1151
  `
1021
- },
1022
- foot: {
1023
- type: "number",
1024
- description: `optional; missing if no path was found (timetable / osr)
1152
+ },
1153
+ foot: {
1154
+ type: 'number',
1155
+ description: `optional; missing if no path was found (timetable / osr)
1025
1156
  footpath duration in minutes for the foot profile
1026
1157
  `
1027
- },
1028
- footRouted: {
1029
- type: "number",
1030
- description: `optional; missing if no path was found with foot routing
1158
+ },
1159
+ footRouted: {
1160
+ type: 'number',
1161
+ description: `optional; missing if no path was found with foot routing
1031
1162
  footpath duration in minutes for the foot profile
1032
1163
  `
1033
- },
1034
- wheelchair: {
1035
- type: "number",
1036
- description: `optional; missing if no path was found with the wheelchair profile
1164
+ },
1165
+ wheelchair: {
1166
+ type: 'number',
1167
+ description: `optional; missing if no path was found with the wheelchair profile
1037
1168
  footpath duration in minutes for the wheelchair profile
1038
1169
  `
1039
- },
1040
- wheelchairRouted: {
1041
- type: "number",
1042
- description: `optional; missing if no path was found with the wheelchair profile
1170
+ },
1171
+ wheelchairRouted: {
1172
+ type: 'number',
1173
+ description: `optional; missing if no path was found with the wheelchair profile
1043
1174
  footpath duration in minutes for the wheelchair profile
1044
1175
  `
1045
- },
1046
- wheelchairUsesElevator: {
1047
- type: "boolean",
1048
- description: `optional; missing if no path was found with the wheelchair profile
1176
+ },
1177
+ wheelchairUsesElevator: {
1178
+ type: 'boolean',
1179
+ description: `optional; missing if no path was found with the wheelchair profile
1049
1180
  true if the wheelchair path uses an elevator
1050
1181
  `
1051
- }
1052
- }
1182
+ }
1183
+ }
1053
1184
  };
1054
1185
 
1055
1186
  export {
1056
- AlertCauseSchema,
1057
- AlertEffectSchema,
1058
- AlertSeverityLevelSchema,
1059
- TimeRangeSchema,
1060
- AlertSchema,
1061
- DurationSchema,
1062
- AreaSchema,
1063
- TokenSchema,
1064
- LocationTypeSchema,
1065
- MatchSchema,
1066
- ElevationCostsSchema,
1067
- PedestrianProfileSchema,
1068
- ModeSchema,
1069
- VertexTypeSchema,
1070
- PickupDropoffTypeSchema,
1071
- PlaceSchema,
1072
- ReachablePlaceSchema,
1073
- ReachableSchema,
1074
- StopTimeSchema,
1075
- TripInfoSchema,
1076
- TripSegmentSchema,
1077
- DirectionSchema,
1078
- EncodedPolylineSchema,
1079
- StepInstructionSchema,
1080
- RentalFormFactorSchema,
1081
- RentalPropulsionTypeSchema,
1082
- RentalReturnConstraintSchema,
1083
- RentalSchema,
1084
- LegSchema,
1085
- RiderCategorySchema,
1086
- FareMediaTypeSchema,
1087
- FareMediaSchema,
1088
- FareProductSchema,
1089
- FareTransferRuleSchema,
1090
- FareTransferSchema,
1091
- ItinerarySchema,
1092
- FootpathSchema
1187
+ AlertCauseSchema,
1188
+ AlertEffectSchema,
1189
+ AlertSeverityLevelSchema,
1190
+ TimeRangeSchema,
1191
+ AlertSchema,
1192
+ DurationSchema,
1193
+ AreaSchema,
1194
+ TokenSchema,
1195
+ LocationTypeSchema,
1196
+ MatchSchema,
1197
+ ElevationCostsSchema,
1198
+ PedestrianProfileSchema,
1199
+ ModeSchema,
1200
+ VertexTypeSchema,
1201
+ PickupDropoffTypeSchema,
1202
+ PlaceSchema,
1203
+ ReachablePlaceSchema,
1204
+ ReachableSchema,
1205
+ StopTimeSchema,
1206
+ TripInfoSchema,
1207
+ TripSegmentSchema,
1208
+ DirectionSchema,
1209
+ EncodedPolylineSchema,
1210
+ StepInstructionSchema,
1211
+ RentalFormFactorSchema,
1212
+ RentalPropulsionTypeSchema,
1213
+ RentalReturnConstraintSchema,
1214
+ RentalSchema,
1215
+ LegSchema,
1216
+ RiderCategorySchema,
1217
+ FareMediaTypeSchema,
1218
+ FareMediaSchema,
1219
+ FareProductSchema,
1220
+ FareTransferRuleSchema,
1221
+ FareTransferSchema,
1222
+ ItinerarySchema,
1223
+ FootpathSchema
1093
1224
  };