@golemio/pid 2.2.11-dev.598014130 → 2.2.11-dev.600085771
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/.gitkeep +0 -0
- package/docs/openapi-input.yaml +318 -0
- package/docs/openapi-output.yaml +1772 -0
- package/docs/pid_docs_trains_proposal.pdf +0 -0
- package/package.json +1 -1
package/docs/.gitkeep
ADDED
|
File without changes
|
|
@@ -0,0 +1,318 @@
|
|
|
1
|
+
openapi: 3.0.3
|
|
2
|
+
info:
|
|
3
|
+
title: 🚋 Public Transport | Golemio Input Gateway
|
|
4
|
+
description: >-
|
|
5
|
+
<p>Open RESTful API gateway for Golemio.cz Prague Data Plafrorm.</p>
|
|
6
|
+
<p>Publisher of the data is ROPID. Schedules are valid for upcoming ~12
|
|
7
|
+
days, but can change as they are updated every day.</p> <p>More about at <a
|
|
8
|
+
href="https://pid.cz/o-systemu/opendata/">pid.cz</a>.</p>
|
|
9
|
+
version: 1.0.0
|
|
10
|
+
contact:
|
|
11
|
+
name: Golemio Prague Data Plaform
|
|
12
|
+
email: golemio@operatorict.cz
|
|
13
|
+
url: https://golemio.cz
|
|
14
|
+
servers:
|
|
15
|
+
- url: https://api.golemio.cz/v2
|
|
16
|
+
description: Main (production) server
|
|
17
|
+
- url: https://rabin.golemio.cz/v2
|
|
18
|
+
description: Test (development) server
|
|
19
|
+
tags:
|
|
20
|
+
- name: 🛤 Vehicle Positions
|
|
21
|
+
description: ""
|
|
22
|
+
paths:
|
|
23
|
+
/vehiclepositions:
|
|
24
|
+
post:
|
|
25
|
+
summary: POST Vehicle Positions
|
|
26
|
+
description: ""
|
|
27
|
+
tags:
|
|
28
|
+
- 🛤 Vehicle Positions
|
|
29
|
+
requestBody:
|
|
30
|
+
required: true
|
|
31
|
+
content:
|
|
32
|
+
text/xml:
|
|
33
|
+
schema:
|
|
34
|
+
$ref: "#/components/schemas/VehiclePositions"
|
|
35
|
+
examples:
|
|
36
|
+
xml:
|
|
37
|
+
$ref: "#/components/examples/VehiclePositionsBodyExample"
|
|
38
|
+
responses:
|
|
39
|
+
"204":
|
|
40
|
+
description: Successful Operation
|
|
41
|
+
|
|
42
|
+
"422":
|
|
43
|
+
description: Unprocessable Entity
|
|
44
|
+
content:
|
|
45
|
+
application/json:
|
|
46
|
+
schema:
|
|
47
|
+
$ref: "#/components/schemas/Error"
|
|
48
|
+
example:
|
|
49
|
+
error_description: "VehiclePositionsController validation failed: m.spoj.0.$.lin: Path `$.lin` is required."
|
|
50
|
+
error_message: "Unprocessable Entity"
|
|
51
|
+
error_status: 422
|
|
52
|
+
"400":
|
|
53
|
+
description: Bad Request
|
|
54
|
+
content:
|
|
55
|
+
application/json:
|
|
56
|
+
schema:
|
|
57
|
+
$ref: "#/components/schemas/Error"
|
|
58
|
+
example:
|
|
59
|
+
error_message: "Bad Request"
|
|
60
|
+
error_status: 400
|
|
61
|
+
"406":
|
|
62
|
+
description: Not Acceptable
|
|
63
|
+
"413":
|
|
64
|
+
description: Payload Too Large
|
|
65
|
+
content:
|
|
66
|
+
application/json:
|
|
67
|
+
schema:
|
|
68
|
+
$ref: "#/components/schemas/Error"
|
|
69
|
+
example:
|
|
70
|
+
error_message: "Request entity too large"
|
|
71
|
+
error_status: 413
|
|
72
|
+
"401":
|
|
73
|
+
description: Unauthorized
|
|
74
|
+
content:
|
|
75
|
+
application/json:
|
|
76
|
+
schema:
|
|
77
|
+
$ref: "#/components/schemas/Error"
|
|
78
|
+
example:
|
|
79
|
+
error_message: "API key is missing or invalid"
|
|
80
|
+
error_status: 401
|
|
81
|
+
headers:
|
|
82
|
+
WWW_Authenticate:
|
|
83
|
+
schema:
|
|
84
|
+
type: string
|
|
85
|
+
|
|
86
|
+
components:
|
|
87
|
+
schemas:
|
|
88
|
+
VehiclePositions:
|
|
89
|
+
title: Vehicle Positions
|
|
90
|
+
type: object
|
|
91
|
+
xml:
|
|
92
|
+
name: m
|
|
93
|
+
wrapped: true
|
|
94
|
+
properties:
|
|
95
|
+
disp:
|
|
96
|
+
type: string
|
|
97
|
+
example: "http://77.93.194.81:8716/api"
|
|
98
|
+
xml:
|
|
99
|
+
attribute: true
|
|
100
|
+
SpojArray:
|
|
101
|
+
type: array
|
|
102
|
+
items:
|
|
103
|
+
$ref: "#/components/schemas/VehiclePositionsSpoj"
|
|
104
|
+
|
|
105
|
+
VehiclePositionsSpoj:
|
|
106
|
+
title: Vehicle Positions Spoj
|
|
107
|
+
type: object
|
|
108
|
+
xml:
|
|
109
|
+
name: spoj
|
|
110
|
+
properties:
|
|
111
|
+
lin:
|
|
112
|
+
type: number
|
|
113
|
+
format: int64
|
|
114
|
+
example: 999999
|
|
115
|
+
xml:
|
|
116
|
+
attribute: true
|
|
117
|
+
alias:
|
|
118
|
+
type: string
|
|
119
|
+
example: "155"
|
|
120
|
+
xml:
|
|
121
|
+
attribute: true
|
|
122
|
+
spoj:
|
|
123
|
+
type: string
|
|
124
|
+
example: "1"
|
|
125
|
+
xml:
|
|
126
|
+
attribute: true
|
|
127
|
+
t:
|
|
128
|
+
type: string
|
|
129
|
+
example: "3"
|
|
130
|
+
xml:
|
|
131
|
+
attribute: true
|
|
132
|
+
sled:
|
|
133
|
+
type: string
|
|
134
|
+
example: "2"
|
|
135
|
+
xml:
|
|
136
|
+
attribute: true
|
|
137
|
+
np:
|
|
138
|
+
type: boolean
|
|
139
|
+
example: true
|
|
140
|
+
xml:
|
|
141
|
+
attribute: true
|
|
142
|
+
zrus:
|
|
143
|
+
type: boolean
|
|
144
|
+
example: false
|
|
145
|
+
xml:
|
|
146
|
+
attribute: true
|
|
147
|
+
lat:
|
|
148
|
+
type: number
|
|
149
|
+
format: float
|
|
150
|
+
example: 50.08323
|
|
151
|
+
xml:
|
|
152
|
+
attribute: true
|
|
153
|
+
lng:
|
|
154
|
+
type: number
|
|
155
|
+
format: float
|
|
156
|
+
example: 14.51035
|
|
157
|
+
xml:
|
|
158
|
+
attribute: true
|
|
159
|
+
cpoz:
|
|
160
|
+
type: string
|
|
161
|
+
example: "11:09:06"
|
|
162
|
+
xml:
|
|
163
|
+
attribute: true
|
|
164
|
+
po:
|
|
165
|
+
type: string
|
|
166
|
+
example: "1"
|
|
167
|
+
xml:
|
|
168
|
+
attribute: true
|
|
169
|
+
zast:
|
|
170
|
+
type: number
|
|
171
|
+
format: int64
|
|
172
|
+
example: 56699
|
|
173
|
+
xml:
|
|
174
|
+
attribute: true
|
|
175
|
+
zpoz_prij:
|
|
176
|
+
type: string
|
|
177
|
+
example: "426"
|
|
178
|
+
xml:
|
|
179
|
+
attribute: true
|
|
180
|
+
zpoz_odj:
|
|
181
|
+
type: string
|
|
182
|
+
example: "426"
|
|
183
|
+
xml:
|
|
184
|
+
attribute: true
|
|
185
|
+
|
|
186
|
+
ZastArray:
|
|
187
|
+
type: array
|
|
188
|
+
items:
|
|
189
|
+
$ref: "#/components/schemas/VehiclePositionsZast"
|
|
190
|
+
|
|
191
|
+
required:
|
|
192
|
+
- lin
|
|
193
|
+
- spoj
|
|
194
|
+
- t
|
|
195
|
+
- sled
|
|
196
|
+
- np
|
|
197
|
+
- zrus
|
|
198
|
+
|
|
199
|
+
VehiclePositionsZast:
|
|
200
|
+
title: Vehicle Positions Zast
|
|
201
|
+
type: object
|
|
202
|
+
xml:
|
|
203
|
+
name: zast
|
|
204
|
+
properties:
|
|
205
|
+
zast:
|
|
206
|
+
type: number
|
|
207
|
+
format: int64
|
|
208
|
+
example: 57517
|
|
209
|
+
xml:
|
|
210
|
+
attribute: true
|
|
211
|
+
stan:
|
|
212
|
+
type: string
|
|
213
|
+
example: "C"
|
|
214
|
+
xml:
|
|
215
|
+
attribute: true
|
|
216
|
+
prij:
|
|
217
|
+
type: string
|
|
218
|
+
example: ""
|
|
219
|
+
xml:
|
|
220
|
+
attribute: true
|
|
221
|
+
odj:
|
|
222
|
+
type: string
|
|
223
|
+
example: "00:50"
|
|
224
|
+
xml:
|
|
225
|
+
attribute: true
|
|
226
|
+
zpoz_typ:
|
|
227
|
+
type: string
|
|
228
|
+
example: "3"
|
|
229
|
+
xml:
|
|
230
|
+
attribute: true
|
|
231
|
+
zpoz_prij:
|
|
232
|
+
type: number
|
|
233
|
+
format: int64
|
|
234
|
+
example: 311
|
|
235
|
+
xml:
|
|
236
|
+
attribute: true
|
|
237
|
+
zpoz_odj:
|
|
238
|
+
type: number
|
|
239
|
+
format: int64
|
|
240
|
+
example: 311
|
|
241
|
+
xml:
|
|
242
|
+
attribute: true
|
|
243
|
+
required:
|
|
244
|
+
- zast
|
|
245
|
+
- zpoz_typ
|
|
246
|
+
|
|
247
|
+
Error:
|
|
248
|
+
title: Error
|
|
249
|
+
type: object
|
|
250
|
+
properties:
|
|
251
|
+
error_description:
|
|
252
|
+
type: string
|
|
253
|
+
error_message:
|
|
254
|
+
type: string
|
|
255
|
+
error_status:
|
|
256
|
+
type: number
|
|
257
|
+
format: int64
|
|
258
|
+
required:
|
|
259
|
+
- error_message
|
|
260
|
+
- error_status
|
|
261
|
+
|
|
262
|
+
examples:
|
|
263
|
+
VehiclePositionsBodyExample:
|
|
264
|
+
value: |-
|
|
265
|
+
<?xml version="1.0" encoding="UTF-8"?>
|
|
266
|
+
<m disp="http://77.93.194.81:8716/api">
|
|
267
|
+
<spoj lin="999999" alias="155" spoj="1" t="3" sled="2" np="true" zrus="false" lat="50.08323" lng="14.51035" cpoz="11:09:06" po="1" zast="56699" zpoz_prij="426" zpoz_odj="426">
|
|
268
|
+
<zast zast="57517" stan="C" prij="" odj="11:00" zpoz_typ="3" zpoz_prij="311" zpoz_odj="311"></zast>
|
|
269
|
+
<zast zast="56699" stan="A" prij="" odj="11:01" zpoz_typ="3" zpoz_prij="351" zpoz_odj="351"></zast>
|
|
270
|
+
<zast zast="56699" stan="E" prij="" odj="11:02" zpoz_typ="3" zpoz_prij="426" zpoz_odj="426"></zast>
|
|
271
|
+
<zast zast="57515" stan="A" prij="" odj="11:04" zpoz_typ="2" zpoz_prij="426" zpoz_odj="426"></zast>
|
|
272
|
+
<zast zast="56700" stan="A" prij="" odj="11:06" zpoz_typ="2" zpoz_prij="426" zpoz_odj="426"></zast>
|
|
273
|
+
<zast zast="57515" stan="B" prij="" odj="11:07" zpoz_typ="2" zpoz_prij="426" zpoz_odj="426"></zast>
|
|
274
|
+
<zast zast="65151" stan="A" prij="" odj="11:09" zpoz_typ="2" zpoz_prij="426" zpoz_odj="426"></zast>
|
|
275
|
+
<zast zast="65163" stan="A" prij="" odj="11:10" zpoz_typ="2" zpoz_prij="426" zpoz_odj="426"></zast>
|
|
276
|
+
<zast zast="57511" stan="B" prij="" odj="11:11" zpoz_typ="2" zpoz_prij="426" zpoz_odj="426"></zast>
|
|
277
|
+
<zast zast="57512" stan="A" prij="" odj="11:13" zpoz_typ="2" zpoz_prij="426" zpoz_odj="426"></zast>
|
|
278
|
+
<zast zast="57513" stan="A" prij="" odj="11:14" zpoz_typ="2" zpoz_prij="426" zpoz_odj="426"></zast>
|
|
279
|
+
<zast zast="57514" stan="B" prij="" odj="11:16" zpoz_typ="2" zpoz_prij="426" zpoz_odj="426"></zast>
|
|
280
|
+
<zast zast="27902" stan="I" prij="" odj="11:18" zpoz_typ="2" zpoz_prij="426" zpoz_odj="426"></zast>
|
|
281
|
+
<zast zast="27902" stan="G" prij="" odj="11:19" zpoz_typ="2" zpoz_prij="426" zpoz_odj="426"></zast>
|
|
282
|
+
<zast zast="56703" stan="C" prij="11:20" odj="" zpoz_typ="0" zpoz_prij="-2147483648" zpoz_odj="-2147483648"></zast>
|
|
283
|
+
</spoj>
|
|
284
|
+
<spoj lin="999999" alias="155" spoj="2" t="3" sled="2" np="true" zrus="false" lat="50.08323" lng="14.51035" cpoz="00:02:16" po="1" zast="56699" zpoz_prij="426" zpoz_odj="426">
|
|
285
|
+
<zast zast="57517" stan="C" prij="" odj="23:50" zpoz_typ="3" zpoz_prij="311" zpoz_odj="311"></zast>
|
|
286
|
+
<zast zast="56699" stan="A" prij="" odj="23:51" zpoz_typ="3" zpoz_prij="351" zpoz_odj="351"></zast>
|
|
287
|
+
<zast zast="56699" stan="E" prij="" odj="23:52" zpoz_typ="3" zpoz_prij="426" zpoz_odj="426"></zast>
|
|
288
|
+
<zast zast="57515" stan="A" prij="" odj="23:54" zpoz_typ="2" zpoz_prij="426" zpoz_odj="426"></zast>
|
|
289
|
+
<zast zast="56700" stan="A" prij="" odj="23:56" zpoz_typ="2" zpoz_prij="426" zpoz_odj="426"></zast>
|
|
290
|
+
<zast zast="57515" stan="B" prij="" odj="23:57" zpoz_typ="2" zpoz_prij="426" zpoz_odj="426"></zast>
|
|
291
|
+
<zast zast="65151" stan="A" prij="" odj="23:59" zpoz_typ="2" zpoz_prij="426" zpoz_odj="426"></zast>
|
|
292
|
+
<zast zast="65163" stan="A" prij="" odj="00:00" zpoz_typ="2" zpoz_prij="426" zpoz_odj="426"></zast>
|
|
293
|
+
<zast zast="57511" stan="B" prij="" odj="00:01" zpoz_typ="2" zpoz_prij="426" zpoz_odj="426"></zast>
|
|
294
|
+
<zast zast="57512" stan="A" prij="" odj="00:03" zpoz_typ="2" zpoz_prij="426" zpoz_odj="426"></zast>
|
|
295
|
+
<zast zast="57513" stan="A" prij="" odj="00:04" zpoz_typ="2" zpoz_prij="426" zpoz_odj="426"></zast>
|
|
296
|
+
<zast zast="57514" stan="B" prij="" odj="00:06" zpoz_typ="2" zpoz_prij="426" zpoz_odj="426"></zast>
|
|
297
|
+
<zast zast="27902" stan="I" prij="" odj="00:08" zpoz_typ="2" zpoz_prij="426" zpoz_odj="426"></zast>
|
|
298
|
+
<zast zast="27902" stan="G" prij="" odj="00:09" zpoz_typ="2" zpoz_prij="426" zpoz_odj="426"></zast>
|
|
299
|
+
<zast zast="56703" stan="C" prij="00:10" odj="" zpoz_typ="0" zpoz_prij="-2147483648" zpoz_odj="-2147483648"></zast>
|
|
300
|
+
</spoj>
|
|
301
|
+
<spoj lin="999999" alias="155" spoj="3" t="3" sled="2" np="true" zrus="false" lat="50.08323" lng="14.51035" cpoz="00:51:16" po="1" zast="56699" zpoz_prij="426" zpoz_odj="426">
|
|
302
|
+
<zast zast="57517" stan="C" prij="" odj="00:50" zpoz_typ="3" zpoz_prij="311" zpoz_odj="311"></zast>
|
|
303
|
+
<zast zast="56699" stan="A" prij="" odj="00:51" zpoz_typ="3" zpoz_prij="351" zpoz_odj="351"></zast>
|
|
304
|
+
<zast zast="56699" stan="E" prij="" odj="00:52" zpoz_typ="3" zpoz_prij="426" zpoz_odj="426"></zast>
|
|
305
|
+
<zast zast="57515" stan="A" prij="" odj="00:54" zpoz_typ="2" zpoz_prij="426" zpoz_odj="426"></zast>
|
|
306
|
+
<zast zast="56700" stan="A" prij="" odj="00:56" zpoz_typ="2" zpoz_prij="426" zpoz_odj="426"></zast>
|
|
307
|
+
<zast zast="57515" stan="B" prij="" odj="00:57" zpoz_typ="2" zpoz_prij="426" zpoz_odj="426"></zast>
|
|
308
|
+
<zast zast="65151" stan="A" prij="" odj="00:59" zpoz_typ="2" zpoz_prij="426" zpoz_odj="426"></zast>
|
|
309
|
+
<zast zast="65163" stan="A" prij="" odj="01:00" zpoz_typ="2" zpoz_prij="426" zpoz_odj="426"></zast>
|
|
310
|
+
<zast zast="57511" stan="B" prij="" odj="01:01" zpoz_typ="2" zpoz_prij="426" zpoz_odj="426"></zast>
|
|
311
|
+
<zast zast="57512" stan="A" prij="" odj="01:03" zpoz_typ="2" zpoz_prij="426" zpoz_odj="426"></zast>
|
|
312
|
+
<zast zast="57513" stan="A" prij="" odj="01:04" zpoz_typ="2" zpoz_prij="426" zpoz_odj="426"></zast>
|
|
313
|
+
<zast zast="57514" stan="B" prij="" odj="01:06" zpoz_typ="2" zpoz_prij="426" zpoz_odj="426"></zast>
|
|
314
|
+
<zast zast="27902" stan="I" prij="" odj="01:08" zpoz_typ="2" zpoz_prij="426" zpoz_odj="426"></zast>
|
|
315
|
+
<zast zast="27902" stan="G" prij="" odj="01:09" zpoz_typ="2" zpoz_prij="426" zpoz_odj="426"></zast>
|
|
316
|
+
<zast zast="56703" stan="C" prij="01:10" odj="" zpoz_typ="0" zpoz_prij="-2147483648" zpoz_odj="-2147483648"></zast>
|
|
317
|
+
</spoj>
|
|
318
|
+
</m>
|