@golemio/pid 2.13.6-rc.1315612486 → 2.13.6
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.
- package/docs/openapi-output.yaml +141 -4
- package/package.json +1 -1
package/docs/openapi-output.yaml
CHANGED
|
@@ -23,10 +23,10 @@ tags:
|
|
|
23
23
|
description: General Transit Feed Specification data about the city's public transportation schedules in form of an API.
|
|
24
24
|
|
|
25
25
|
- name: 🗺 GTFS Realtime
|
|
26
|
-
description: Protobuf feeds of GTFS Realtime data. The feeds are updated every 20 seconds. Proto definitions can be found at [gtfs-realtime-OVapi.proto](https://gitlab.com/operator-ict/golemio/code/ovapi-gtfs-realtime-bindings/-/blob/master/src/gtfs-realtime-OVapi.proto).
|
|
26
|
+
description: Protobuf feeds of GTFS Realtime data. The feeds are updated every 20 seconds. Proto definitions can be found at [gtfs-realtime-OVapi.proto](https://gitlab.com/operator-ict/golemio/code/ovapi-gtfs-realtime-bindings/-/blob/master/src/gtfs-realtime-OVapi.proto). You can inspect the data in human-readable form using the [GTFS Realtime Inspector](https://gitlab.com/operator-ict/golemio/code/modules/pid/-/tree/master/toolkit/gtfs-realtime-inspector).
|
|
27
27
|
|
|
28
28
|
- name: 🛤 PID Realtime Positions
|
|
29
|
-
description:
|
|
29
|
+
description: Realtime positions of vehicles in custom GeoJSON format.
|
|
30
30
|
|
|
31
31
|
- name: 🚏 PID Departure Boards
|
|
32
32
|
description: ""
|
|
@@ -75,6 +75,12 @@ paths:
|
|
|
75
75
|
responses:
|
|
76
76
|
"200":
|
|
77
77
|
description: successful operation
|
|
78
|
+
headers:
|
|
79
|
+
Cache-Control:
|
|
80
|
+
description: Cache control directive for caching proxies
|
|
81
|
+
schema:
|
|
82
|
+
type: string
|
|
83
|
+
example: public, s-maxage=14400, stale-while-revalidate=60
|
|
78
84
|
content:
|
|
79
85
|
application/json:
|
|
80
86
|
schema:
|
|
@@ -112,6 +118,12 @@ paths:
|
|
|
112
118
|
responses:
|
|
113
119
|
"200":
|
|
114
120
|
description: successful operation
|
|
121
|
+
headers:
|
|
122
|
+
Cache-Control:
|
|
123
|
+
description: Cache control directive for caching proxies
|
|
124
|
+
schema:
|
|
125
|
+
type: string
|
|
126
|
+
example: public, s-maxage=14400, stale-while-revalidate=60
|
|
115
127
|
content:
|
|
116
128
|
application/json:
|
|
117
129
|
schema:
|
|
@@ -139,6 +151,12 @@ paths:
|
|
|
139
151
|
responses:
|
|
140
152
|
"200":
|
|
141
153
|
description: successful operation
|
|
154
|
+
headers:
|
|
155
|
+
Cache-Control:
|
|
156
|
+
description: Cache control directive for caching proxies
|
|
157
|
+
schema:
|
|
158
|
+
type: string
|
|
159
|
+
example: public, s-maxage=14400, stale-while-revalidate=60
|
|
142
160
|
content:
|
|
143
161
|
application/json:
|
|
144
162
|
schema:
|
|
@@ -188,6 +206,12 @@ paths:
|
|
|
188
206
|
responses:
|
|
189
207
|
"200":
|
|
190
208
|
description: successful operation
|
|
209
|
+
headers:
|
|
210
|
+
Cache-Control:
|
|
211
|
+
description: Cache control directive for caching proxies
|
|
212
|
+
schema:
|
|
213
|
+
type: string
|
|
214
|
+
example: public, s-maxage=14400, stale-while-revalidate=60
|
|
191
215
|
content:
|
|
192
216
|
application/json:
|
|
193
217
|
schema:
|
|
@@ -257,6 +281,12 @@ paths:
|
|
|
257
281
|
responses:
|
|
258
282
|
"200":
|
|
259
283
|
description: successful operation
|
|
284
|
+
headers:
|
|
285
|
+
Cache-Control:
|
|
286
|
+
description: Cache control directive for caching proxies
|
|
287
|
+
schema:
|
|
288
|
+
type: string
|
|
289
|
+
example: public, s-maxage=14400, stale-while-revalidate=60
|
|
260
290
|
content:
|
|
261
291
|
application/json:
|
|
262
292
|
schema:
|
|
@@ -309,6 +339,12 @@ paths:
|
|
|
309
339
|
responses:
|
|
310
340
|
"200":
|
|
311
341
|
description: successful operation
|
|
342
|
+
headers:
|
|
343
|
+
Cache-Control:
|
|
344
|
+
description: Cache control directive for caching proxies
|
|
345
|
+
schema:
|
|
346
|
+
type: string
|
|
347
|
+
example: public, s-maxage=14400, stale-while-revalidate=60
|
|
312
348
|
content:
|
|
313
349
|
application/json:
|
|
314
350
|
schema:
|
|
@@ -385,6 +421,12 @@ paths:
|
|
|
385
421
|
responses:
|
|
386
422
|
"200":
|
|
387
423
|
description: successful operation
|
|
424
|
+
headers:
|
|
425
|
+
Cache-Control:
|
|
426
|
+
description: Cache control directive for caching proxies
|
|
427
|
+
schema:
|
|
428
|
+
type: string
|
|
429
|
+
example: public, s-maxage=14400, stale-while-revalidate=60
|
|
388
430
|
content:
|
|
389
431
|
application/json:
|
|
390
432
|
schema:
|
|
@@ -423,6 +465,12 @@ paths:
|
|
|
423
465
|
responses:
|
|
424
466
|
"200":
|
|
425
467
|
description: successful operation
|
|
468
|
+
headers:
|
|
469
|
+
Cache-Control:
|
|
470
|
+
description: Cache control directive for caching proxies
|
|
471
|
+
schema:
|
|
472
|
+
type: string
|
|
473
|
+
example: public, s-maxage=14400, stale-while-revalidate=60
|
|
426
474
|
content:
|
|
427
475
|
application/json:
|
|
428
476
|
schema:
|
|
@@ -499,6 +547,12 @@ paths:
|
|
|
499
547
|
responses:
|
|
500
548
|
"200":
|
|
501
549
|
description: successful operation
|
|
550
|
+
headers:
|
|
551
|
+
Cache-Control:
|
|
552
|
+
description: Cache control directive for caching proxies
|
|
553
|
+
schema:
|
|
554
|
+
type: string
|
|
555
|
+
example: public, s-maxage=14400, stale-while-revalidate=60
|
|
502
556
|
content:
|
|
503
557
|
application/json:
|
|
504
558
|
schema:
|
|
@@ -584,6 +638,17 @@ paths:
|
|
|
584
638
|
responses:
|
|
585
639
|
"200":
|
|
586
640
|
description: successful operation
|
|
641
|
+
headers:
|
|
642
|
+
Cache-Control:
|
|
643
|
+
description: Cache control directive for caching proxies
|
|
644
|
+
schema:
|
|
645
|
+
type: string
|
|
646
|
+
example: public, s-maxage=5, stale-while-revalidate=5
|
|
647
|
+
x-last-modified:
|
|
648
|
+
description: Timestamp of the latest resource update. Use it as `?updatedSince` query parameter to obtain only newer data than this value.
|
|
649
|
+
schema:
|
|
650
|
+
type: string
|
|
651
|
+
example: "2024-06-03T09:16:16.973Z"
|
|
587
652
|
content:
|
|
588
653
|
application/json:
|
|
589
654
|
schema:
|
|
@@ -644,6 +709,12 @@ paths:
|
|
|
644
709
|
responses:
|
|
645
710
|
"200":
|
|
646
711
|
description: successful operation
|
|
712
|
+
headers:
|
|
713
|
+
Cache-Control:
|
|
714
|
+
description: Cache control directive for caching proxies
|
|
715
|
+
schema:
|
|
716
|
+
type: string
|
|
717
|
+
example: public, s-maxage=5, stale-while-revalidate=5
|
|
647
718
|
content:
|
|
648
719
|
application/json:
|
|
649
720
|
schema:
|
|
@@ -667,6 +738,12 @@ paths:
|
|
|
667
738
|
responses:
|
|
668
739
|
"200":
|
|
669
740
|
description: successful operation
|
|
741
|
+
headers:
|
|
742
|
+
Cache-Control:
|
|
743
|
+
description: Cache control directive for caching proxies
|
|
744
|
+
schema:
|
|
745
|
+
type: string
|
|
746
|
+
example: no-store, no-cache, must-revalidate
|
|
670
747
|
content:
|
|
671
748
|
application/octet-stream:
|
|
672
749
|
schema:
|
|
@@ -686,6 +763,12 @@ paths:
|
|
|
686
763
|
responses:
|
|
687
764
|
"200":
|
|
688
765
|
description: successful operation
|
|
766
|
+
headers:
|
|
767
|
+
Cache-Control:
|
|
768
|
+
description: Cache control directive for caching proxies
|
|
769
|
+
schema:
|
|
770
|
+
type: string
|
|
771
|
+
example: no-store, no-cache, must-revalidate
|
|
689
772
|
content:
|
|
690
773
|
application/octet-stream:
|
|
691
774
|
schema:
|
|
@@ -705,6 +788,12 @@ paths:
|
|
|
705
788
|
responses:
|
|
706
789
|
"200":
|
|
707
790
|
description: successful operation
|
|
791
|
+
headers:
|
|
792
|
+
Cache-Control:
|
|
793
|
+
description: Cache control directive for caching proxies
|
|
794
|
+
schema:
|
|
795
|
+
type: string
|
|
796
|
+
example: no-store, no-cache, must-revalidate
|
|
708
797
|
content:
|
|
709
798
|
application/octet-stream:
|
|
710
799
|
schema:
|
|
@@ -724,6 +813,12 @@ paths:
|
|
|
724
813
|
responses:
|
|
725
814
|
"200":
|
|
726
815
|
description: successful operation
|
|
816
|
+
headers:
|
|
817
|
+
Cache-Control:
|
|
818
|
+
description: Cache control directive for caching proxies
|
|
819
|
+
schema:
|
|
820
|
+
type: string
|
|
821
|
+
example: no-store, no-cache, must-revalidate
|
|
727
822
|
content:
|
|
728
823
|
application/octet-stream:
|
|
729
824
|
schema:
|
|
@@ -874,6 +969,12 @@ paths:
|
|
|
874
969
|
responses:
|
|
875
970
|
"200":
|
|
876
971
|
description: Can return empty data in departures property (empty array []) if no departures were found
|
|
972
|
+
headers:
|
|
973
|
+
Cache-Control:
|
|
974
|
+
description: Cache control directive for caching proxies
|
|
975
|
+
schema:
|
|
976
|
+
type: string
|
|
977
|
+
example: public, s-maxage=5, stale-while-revalidate=5
|
|
877
978
|
content:
|
|
878
979
|
application/json:
|
|
879
980
|
schema:
|
|
@@ -892,6 +993,12 @@ paths:
|
|
|
892
993
|
responses:
|
|
893
994
|
"200":
|
|
894
995
|
description: List of all active infotexts
|
|
996
|
+
headers:
|
|
997
|
+
Cache-Control:
|
|
998
|
+
description: Cache control directive for caching proxies
|
|
999
|
+
schema:
|
|
1000
|
+
type: string
|
|
1001
|
+
example: public, s-maxage=25, stale-while-revalidate=10
|
|
895
1002
|
content:
|
|
896
1003
|
application/json:
|
|
897
1004
|
schema:
|
|
@@ -984,6 +1091,12 @@ paths:
|
|
|
984
1091
|
responses:
|
|
985
1092
|
200:
|
|
986
1093
|
description: OK
|
|
1094
|
+
headers:
|
|
1095
|
+
Cache-Control:
|
|
1096
|
+
description: Cache control directive for caching proxies
|
|
1097
|
+
schema:
|
|
1098
|
+
type: string
|
|
1099
|
+
example: public, s-maxage=14400, stale-while-revalidate=60
|
|
987
1100
|
content:
|
|
988
1101
|
application/json; charset=utf-8:
|
|
989
1102
|
schema:
|
|
@@ -1037,6 +1150,12 @@ paths:
|
|
|
1037
1150
|
responses:
|
|
1038
1151
|
200:
|
|
1039
1152
|
description: OK
|
|
1153
|
+
headers:
|
|
1154
|
+
Cache-Control:
|
|
1155
|
+
description: Cache control directive for caching proxies
|
|
1156
|
+
schema:
|
|
1157
|
+
type: string
|
|
1158
|
+
example: public, s-maxage=5, stale-while-revalidate=5
|
|
1040
1159
|
content:
|
|
1041
1160
|
application/json; charset=utf-8:
|
|
1042
1161
|
schema:
|
|
@@ -1086,6 +1205,12 @@ paths:
|
|
|
1086
1205
|
responses:
|
|
1087
1206
|
200:
|
|
1088
1207
|
description: OK
|
|
1208
|
+
headers:
|
|
1209
|
+
Cache-Control:
|
|
1210
|
+
description: Cache control directive for caching proxies
|
|
1211
|
+
schema:
|
|
1212
|
+
type: string
|
|
1213
|
+
example: public, s-maxage=5, stale-while-revalidate=5
|
|
1089
1214
|
content:
|
|
1090
1215
|
application/json; charset=utf-8:
|
|
1091
1216
|
schema:
|
|
@@ -1099,7 +1224,7 @@ paths:
|
|
|
1099
1224
|
$ref: "#/components/responses/UnauthorizedError"
|
|
1100
1225
|
404:
|
|
1101
1226
|
description: Not found
|
|
1102
|
-
|
|
1227
|
+
|
|
1103
1228
|
/public/vehiclepositions/{vehicleId}{gtfsTripId}:
|
|
1104
1229
|
get:
|
|
1105
1230
|
tags:
|
|
@@ -1146,6 +1271,12 @@ paths:
|
|
|
1146
1271
|
responses:
|
|
1147
1272
|
200:
|
|
1148
1273
|
description: OK
|
|
1274
|
+
headers:
|
|
1275
|
+
Cache-Control:
|
|
1276
|
+
description: Cache control directive for caching proxies
|
|
1277
|
+
schema:
|
|
1278
|
+
type: string
|
|
1279
|
+
example: public, s-maxage=5, stale-while-revalidate=5
|
|
1149
1280
|
content:
|
|
1150
1281
|
application/json; charset=utf-8:
|
|
1151
1282
|
schema:
|
|
@@ -1159,7 +1290,7 @@ paths:
|
|
|
1159
1290
|
$ref: "#/components/responses/UnauthorizedError"
|
|
1160
1291
|
404:
|
|
1161
1292
|
description: Not found
|
|
1162
|
-
|
|
1293
|
+
|
|
1163
1294
|
/public/departureboards:
|
|
1164
1295
|
get:
|
|
1165
1296
|
tags:
|
|
@@ -1203,6 +1334,12 @@ paths:
|
|
|
1203
1334
|
responses:
|
|
1204
1335
|
200:
|
|
1205
1336
|
description: OK
|
|
1337
|
+
headers:
|
|
1338
|
+
Cache-Control:
|
|
1339
|
+
description: Cache control directive for caching proxies
|
|
1340
|
+
schema:
|
|
1341
|
+
type: string
|
|
1342
|
+
example: public, s-maxage=5, stale-while-revalidate=5
|
|
1206
1343
|
content:
|
|
1207
1344
|
application/json:
|
|
1208
1345
|
schema:
|