@golemio/fcd 1.2.11 → 1.2.12-dev.1490003734

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 (3) hide show
  1. package/docs/asyncapi.yaml +350 -0
  2. package/docs/implementation_documentation.md +3 -1
  3. package/package.json +1 -1
package/docs/asyncapi.yaml ADDED
@@ -0,0 +1,350 @@
1
+ asyncapi: 3.0.0
2
+ info:
3
+ title: 🚢 Floating Car Data
4
+ version: 1.0.0
5
+ description: This document describes internal RabbitMQ queues of the FCD (Floating Car Data) module.
6
+ contact:
7
+ name: Golemio Prague Data Plaform
8
+ email: golemio@operatorict.cz
9
+ url: https://golemio.cz
10
+ operations:
11
+ fcd.regionsDataRetention:
12
+ action: "send"
13
+ channel:
14
+ $ref: "#/channels/fcd.regionsDataRetention"
15
+ fcd.saveFloatingCarData:
16
+ action: "send"
17
+ channel:
18
+ $ref: "#/channels/fcd.saveFloatingCarData"
19
+ fcd.saveRegionsData:
20
+ action: "send"
21
+ channel:
22
+ $ref: "#/channels/fcd.saveRegionsData"
23
+ channels:
24
+ fcd.regionsDataRetention:
25
+ address: dataplatform.fcd.regionsDataRetention
26
+ description: Delete data older than 2 days
27
+ bindings:
28
+ amqp:
29
+ is: queue
30
+ queue:
31
+ durable: true
32
+ messages:
33
+ empty:
34
+ $ref: "#/components/messages/emptyMessage"
35
+ fcd.saveFloatingCarData:
36
+ address: dataplatform.fcd.saveFloatingCarData
37
+ description: Save data to PostgreSQL table `fcd.fcd_traff_params_part`
38
+ bindings:
39
+ amqp:
40
+ is: queue
41
+ queue:
42
+ durable: true
43
+ messages:
44
+ data:
45
+ $ref: "#/components/messages/fcd.saveFloatingCarData"
46
+ fcd.saveRegionsData:
47
+ address: dataplatform.fcd.saveFloatingCarData
48
+ description: Save data to PostgreSQL table `fcd.fcd_traff_params_part`
49
+ bindings:
50
+ amqp:
51
+ is: queue
52
+ queue:
53
+ durable: true
54
+ messages:
55
+ data:
56
+ $ref: "#/components/messages/fcd.saveRegionsData"
57
+ components:
58
+ messages:
59
+ emptyMessage:
60
+ title: Empty message
61
+ fcd.saveFloatingCarData:
62
+ payload:
63
+ $ref: "#/components/schemas/fcd.IFloatingCarData"
64
+ fcd.saveRegionsData:
65
+ payload:
66
+ $ref: "#/components/schemas/fcd.IFloatingCarData"
67
+ schemas:
68
+ fcd.IFloatingCarData:
69
+ type: object
70
+ properties:
71
+ "$":
72
+ type: object
73
+ properties:
74
+ modelBaseVersion:
75
+ type: string
76
+ enum:
77
+ - "2"
78
+ required:
79
+ - modelBaseVersion
80
+ additionalProperties: true
81
+ exchange:
82
+ "$ref": "#/components/schemas/fcd.Exchange"
83
+ payloadPublication:
84
+ "$ref": "#/components/schemas/fcd.PayloadPublication"
85
+ required:
86
+ - exchange
87
+ - payloadPublication
88
+ additionalProperties: false
89
+ fcd.Exchange:
90
+ type: object
91
+ properties:
92
+ supplierIdentification:
93
+ "$ref": "#/components/schemas/fcd.InternationalIdentifier"
94
+ exchangeExtension:
95
+ "$ref": "#/components/schemas/fcd._ExtensionType"
96
+ required:
97
+ - supplierIdentification
98
+ fcd._ExtensionType:
99
+ type: object
100
+ fcd.InternationalIdentifier:
101
+ type: object
102
+ properties:
103
+ country:
104
+ type: string
105
+ nationalIdentifier:
106
+ type: string
107
+ internationalIdentifierExtension:
108
+ "$ref": "#/components/schemas/fcd._ExtensionType"
109
+ required:
110
+ - country
111
+ - nationalIdentifier
112
+ additionalProperties: false
113
+ fcd.PayloadPublication:
114
+ type: object
115
+ properties:
116
+ "$":
117
+ type: object
118
+ properties:
119
+ xsi:type:
120
+ type: string
121
+ enum:
122
+ - ElaboratedDataPublication
123
+ lang:
124
+ type: string
125
+ required:
126
+ - xsi:type
127
+ additionalProperties: false
128
+ publicationTime:
129
+ "$ref": "#/components/schemas/fcd.DateTime"
130
+ publicationCreator:
131
+ "$ref": "#/components/schemas/fcd.InternationalIdentifier"
132
+ headerInformation:
133
+ "$ref": "#/components/schemas/fcd.HeaderInformation"
134
+ elaboratedData:
135
+ items:
136
+ "$ref": "#/components/schemas/fcd.ElaboratedData"
137
+ type: array
138
+ required:
139
+ - "$"
140
+ - publicationTime
141
+ - publicationCreator
142
+ - elaboratedData
143
+ additionalProperties: false
144
+ fcd.DateTime:
145
+ type: string
146
+ format: date-time
147
+ fcd.HeaderInformation:
148
+ type: object
149
+ properties:
150
+ confidentiality:
151
+ type: string
152
+ informationStatus:
153
+ type: string
154
+ fcd.ElaboratedData:
155
+ type: object
156
+ properties:
157
+ source:
158
+ type: object
159
+ properties:
160
+ sourceIdentification:
161
+ type: string
162
+ basicData:
163
+ "$ref": "#/components/schemas/fcd.BasicData"
164
+ fcd.BasicData:
165
+ type: object
166
+ properties:
167
+ "$":
168
+ type: object
169
+ properties:
170
+ xsi:type:
171
+ type: string
172
+ enum:
173
+ - TrafficStatus
174
+ - TrafficSpeed
175
+ - TravelTimeData
176
+ required:
177
+ - xsi:type
178
+ additionalProperties: false
179
+ measurementOrCalculationTime:
180
+ type: string
181
+ pertinentLocation:
182
+ "$ref": "#/components/schemas/fcd.PertinentLocation"
183
+ trafficStatusExtension:
184
+ "$ref": "#/components/schemas/fcd.TrafficStatusExtension"
185
+ travelTime:
186
+ "$ref": "#/components/schemas/fcd.TravelTime"
187
+ freeFlowTravelTime:
188
+ "$ref": "#/components/schemas/fcd.FreeFlowTravelTime"
189
+ freeFlowSpeed:
190
+ "$ref": "#/components/schemas/fcd.FreeFlowSpeed"
191
+ averageVehicleSpeed:
192
+ "$ref": "#/components/schemas/fcd.AverageVehicleSpeed"
193
+ required:
194
+ - "$"
195
+ - measurementOrCalculationTime
196
+ - pertinentLocation
197
+ additionalProperties: false
198
+ fcd.PertinentLocation:
199
+ type: object
200
+ properties:
201
+ "$":
202
+ type: object
203
+ properties:
204
+ xsi:type:
205
+ type: string
206
+ enum:
207
+ - LocationByReference
208
+ required:
209
+ - xsi:type
210
+ predefinedLocationReference:
211
+ type: object
212
+ properties:
213
+ "$":
214
+ type: object
215
+ properties:
216
+ targetClass:
217
+ type: string
218
+ id:
219
+ type: string
220
+ version:
221
+ type: string
222
+ required:
223
+ - targetClass
224
+ - id
225
+ - version
226
+ required:
227
+ - "$"
228
+ required:
229
+ - "$"
230
+ - predefinedLocationReference
231
+ fcd.TrafficStatusExtension:
232
+ type: object
233
+ properties:
234
+ ndicFcdExtension:
235
+ type: object
236
+ properties:
237
+ trafficLevel:
238
+ type: object
239
+ properties:
240
+ "$":
241
+ type: object
242
+ properties:
243
+ supplierCalculatedDataQuality:
244
+ type: string
245
+ numberOfInputValuesUsed:
246
+ type: string
247
+ required:
248
+ - supplierCalculatedDataQuality
249
+ - numberOfInputValuesUsed
250
+ trafficLevelValue:
251
+ type: string
252
+ required:
253
+ - "$"
254
+ - trafficLevelValue
255
+ required:
256
+ - trafficLevel
257
+ queueInformation:
258
+ type: object
259
+ properties:
260
+ queueLength:
261
+ type: string
262
+ fromPoint:
263
+ type: string
264
+ toPoint:
265
+ type: string
266
+ required:
267
+ - queueLength
268
+ - fromPoint
269
+ - toPoint
270
+ required:
271
+ - ndicFcdExtension
272
+ additionalProperties: false
273
+ fcd.TravelTime:
274
+ type: object
275
+ properties:
276
+ "$":
277
+ type: object
278
+ properties:
279
+ supplierCalculatedDataQuality:
280
+ type: string
281
+ numberOfInputValuesUsed:
282
+ type: string
283
+ required:
284
+ - supplierCalculatedDataQuality
285
+ - numberOfInputValuesUsed
286
+ additionalProperties: false
287
+ duration:
288
+ type: string
289
+ required:
290
+ - "$"
291
+ - duration
292
+ additionalProperties: false
293
+ fcd.FreeFlowTravelTime:
294
+ type: object
295
+ properties:
296
+ "$":
297
+ type: object
298
+ properties:
299
+ supplierCalculatedDataQuality:
300
+ type: string
301
+ numberOfInputValuesUsed:
302
+ type: string
303
+ required:
304
+ - supplierCalculatedDataQuality
305
+ - numberOfInputValuesUsed
306
+ additionalProperties: false
307
+ duration:
308
+ type: string
309
+ required:
310
+ - duration
311
+ additionalProperties: false
312
+ fcd.FreeFlowSpeed:
313
+ type: object
314
+ properties:
315
+ "$":
316
+ type: object
317
+ properties:
318
+ supplierCalculatedDataQuality:
319
+ type: string
320
+ numberOfInputValuesUsed:
321
+ type: string
322
+ required:
323
+ - supplierCalculatedDataQuality
324
+ - numberOfInputValuesUsed
325
+ additionalProperties: false
326
+ speed:
327
+ type: string
328
+ required:
329
+ - speed
330
+ additionalProperties: false
331
+ fcd.AverageVehicleSpeed:
332
+ type: object
333
+ properties:
334
+ "$":
335
+ type: object
336
+ properties:
337
+ supplierCalculatedDataQuality:
338
+ type: string
339
+ numberOfInputValuesUsed:
340
+ type: string
341
+ required:
342
+ - supplierCalculatedDataQuality
343
+ - numberOfInputValuesUsed
344
+ additionalProperties: false
345
+ speed:
346
+ type: string
347
+ required:
348
+ - "$"
349
+ - speed
350
+ additionalProperties: false
package/docs/implementation_documentation.md CHANGED
@@ -15,6 +15,8 @@ Mame vystavene 2 endpointy viz [openApi spec](./openapi-input.yaml)
15
15
 
16
16
  Vsechny tabulky jsou ve schematu `fcd`
17
17
 
18
+ Interní RabbitMQ fronty jsou popsány v [AsyncAPI](./asyncapi.yaml).
19
+
18
20
  ### *FCDWorker*
19
21
 
20
22
  Fcd modul ma jen jednoho workera ktery se stara o ukladani dat a retenci dat
@@ -100,4 +102,4 @@ uklada data do tabulky `fcd_traff_params_regions`
100
102
  - zdrojové tabulky
101
103
  - je pouzit view `v_traffic_params_all` kde jste spojene tabulky `fcd_traff_params_regions` a `fcd_traff_params_part`
102
104
  - pri zadosti o osmPath je pouzit view `v_traffic_params_all_with_osm_path`/`v_traffic_params_last_hour_osm_path` kde je pripojena tabulka `traffic.rsd_tmc_osm_mapping` pro ziskani `osm_path`
103
- - zobrazi data viz [openapi](./openapi-output.yaml)
105
+ - zobrazi data viz [openapi](./openapi-output.yaml)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@golemio/fcd",
3
- "version": "1.2.11",
3
+ "version": "1.2.12-dev.1490003734",
4
4
  "description": "Golemio Floating Car Data Module",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",