-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yml
553 lines (517 loc) · 12.9 KB
/
openapi.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
openapi: 3.0.3
info:
title: Bruss - Public Transport
description: |-
Trentino Trasporti API proxy, supports map endpoints, for a visual public transport tracking.
contact:
email: [email protected]
license:
name: GPLv3.0
url: https://www.gnu.org/licenses/gpl-3.0.txt
version: 1.0.0
servers:
- url: http://localhost:8000/api/v1/
tags:
- name: map
description: Get data about everything related to the map and the transport schema.
- name: tracking
description: Get data about real time positioning of the public transport vehicles.
paths:
/map/area/{id}:
get:
tags:
- map
summary: Get specific area
parameters:
- name: id
in: path
description: Area id
required: true
schema:
$ref: '#/components/schemas/Id'
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/Area'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/Unprocessable'
/map/area:
get:
tags:
- map
summary: Get available areas
parameters:
- name: type
in: query
description: Area type, whether Urban or Extra(urban)
required: false
schema:
$ref: '#/components/schemas/AreaType'
responses:
'200':
description: success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Area'
'422':
$ref: '#/components/responses/Unprocessable'
/map/route/{id}:
get:
tags:
- map
summary: Get specific route
parameters:
- name: id
in: path
description: Route id
required: true
schema:
$ref: '#/components/schemas/Id'
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/Route'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/Unprocessable'
/map/route:
get:
tags:
- map
summary: Get available routes
parameters:
- name: type
in: query
description: Area type, whether Urban or Extra(urban)
required: false
schema:
$ref: '#/components/schemas/AreaType'
- name: area
in: query
description: Area in which stop is contained
required: false
schema:
$ref: '#/components/schemas/Id'
responses:
'200':
description: success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Route'
'422':
$ref: '#/components/responses/Unprocessable'
/map/stop/{area_type}/{id}:
get:
tags:
- map
summary: Get specific stop
parameters:
- name: id
in: path
description: Stop id
required: true
schema:
$ref: '#/components/schemas/Id'
- name: area_type
in: path
description: Stop area type
required: true
schema:
$ref: '#/components/schemas/AreaType'
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/Stop'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/Unprocessable'
/map/stop/{area_type}/{id}/trips:
get:
tags:
- map
summary: Get trips passing for a specific stop
parameters:
- name: id
in: path
description: Stop id
required: true
schema:
$ref: '#/components/schemas/Id'
- name: area_type
in: path
description: Stop area type
required: true
schema:
$ref: '#/components/schemas/AreaType'
- name: id
in: query
description: Trip id
schema:
$ref: '#/components/schemas/TripId'
responses:
'200':
description: success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Trip'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/Unprocessable'
/map/route/{id}/trips:
get:
tags:
- map
summary: Get trips for a specific route
parameters:
- name: id
in: path
description: Route id
required: true
schema:
$ref: '#/components/schemas/Id'
- name: id
in: query
description: Trip id
schema:
$ref: '#/components/schemas/TripId'
responses:
'200':
description: success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Trip'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/Unprocessable'
/map/stop:
get:
tags:
- map
summary: Get available stops
parameters:
- name: type
in: query
description: Area type, whether Urban or Extra(urban)
required: false
schema:
$ref: '#/components/schemas/AreaType'
responses:
'200':
description: success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Stop'
'422':
$ref: '#/components/responses/Unprocessable'
/map/paths/{paths}:
get:
tags:
- map
summary: Get paths
parameters:
- name: paths
in: path
required: true
schema:
type: array
items:
$ref: '#/components/schemas/PathId'
responses:
'200':
description: success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Stop'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/Unprocessable'
/map/segments/{area_type}/{stop_pairs}:
get:
tags:
- map
summary: Get segments based on stop-stop pairs
parameters:
- name: area_type
in: path
required: true
schema:
$ref: '#/components/schemas/AreaType'
- name: stop_pairs
in: path
required: true
schema:
type: array
items:
$ref: '#/components/schemas/StopPair'
- name: format
in: query
required: false
schema:
$ref: '#/components/schemas/SegmentFormat'
responses:
'200':
description: success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Segment'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/Unprocessable'
components:
schemas:
Id:
type: integer
format: uint16
example: 23
TripId:
type: string
example: "0003098392023091120240621"
AreaType:
type: string
example: u
enum:
- u
- e
TripDirection:
type: string
example: f
enum:
- b
- f
PathId:
type: string
example: 35ed8ab1eb6de4062e7ccbc2d46c2b8e02f1a1e3
SegmentFormat:
type: string
example: coords
enum:
- coords
- poly
StopPair:
type: string
pattern: "^\\d{1,4}-\\d{1,4}"
example: 163-2680
Area:
type: object
properties:
id:
$ref: '#/components/schemas/Id'
label:
type: string
example: Urbano Trento
type:
$ref: '#/components/schemas/AreaType'
Route:
type: object
properties:
id:
$ref: '#/components/schemas/Id'
type:
type: integer
format: uint16
example: 3
area:
$ref: '#/components/schemas/Id'
area_ty:
$ref: '#/components/schemas/AreaType'
color:
type: string
example: CCCCCC
name:
type: string
example: P.Dante P.Fiera Università Mesiano Povo
code:
type: string
example: '5/'
Position:
type: array
minItems: 2
maxItems: 2
items:
type: number
format: float
example:
- 46.065117
- 11.123289
Stop:
type: object
properties:
id:
$ref: "#/components/schemas/Id"
code:
type: string
example: "21545-"
description:
type: string
example: ""
position:
$ref: "#/components/schemas/Position"
altitude:
type: integer
format: uint16
example: 80
name:
type: string
example: Piazza di Fiera
town:
type: string
example: Trento
type:
$ref: "#/components/schemas/AreaType"
wheelchair_boarding:
type: boolean
example: true
Trip:
type: object
properties:
id:
$ref: '#/components/schemas/TripId'
delay:
type: integer
format: int32
example: 2
direction:
$ref: '#/components/schemas/TripDirection'
next_stop:
$ref: '#/components/schemas/Id'
last_stop:
$ref: '#/components/schemas/Id'
bus_id:
type: integer
format: uint16
nullable: true
example: 329
route:
$ref: '#/components/schemas/Id'
headsign:
type: string
example: Povo "Polo Scientifico" Est
path:
$ref: '#/components/schemas/PathId'
times:
type: object
example:
'145':
arrival: 08:06:00
departure: 08:06:00
'147':
arrival: 08:07:00
departure: 08:07:00
'149':
arrival: 08:09:00
departure: 08:09:00
additionalProperties:
type: object
properties:
arrival:
type: string
departure:
type: string
type:
$ref: '#/components/schemas/AreaType'
Segment:
type: object
properties:
from:
$ref: '#/components/schemas/Id'
to:
$ref: '#/components/schemas/Id'
type:
$ref: '#/components/schemas/AreaType'
geometry:
oneOf:
- $ref: '#/components/schemas/Coords'
- $ref: '#/components/schemas/Polyline'
Coords:
type: array
items:
$ref: '#/components/schemas/Position'
Polyline:
type: string
example: "{}zbAcoexGYFiAVg@Lw@POAODsAZ"
ApiError:
type: object
properties:
# status:
# type: integer
# format: uint16
# example: 404
error:
type: string
example: not found
FormError:
type: object
properties:
name:
type: string
example: typeu
value:
type: string
example: u
kind:
type: string
example: unexpected
responses:
Unprocessable:
description: unprocessable entity
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiError'
- type: object
properties:
errors:
type: array
items:
$ref: '#/components/schemas/FormError'
NotFound:
description: not found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
InternalServerError:
description: internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'