@golemio/ndic 1.2.0 → 1.2.1-dev.986624454

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/openapi-input.yaml +965 -0
  2. package/docs/{openapi.yaml → openapi-output.yaml} +237 -237
  3. package/package.json +4 -3
package/docs/{openapi.yaml → openapi-output.yaml} RENAMED
@@ -1,237 +1,237 @@
1
- openapi: 3.0.3
2
- info:
3
- title: 🚧 NDIC
4
- description: >-
5
- version: 1.0.0
6
- contact:
7
- name: Golemio Prague Data Plaform
8
- email: golemio@operatorict.cz
9
- url: https://golemio.cz
10
-
11
- servers:
12
- - url: https://rabin.golemio.cz/v2
13
- description: Test (development) server
14
- - url: https://api.golemio.cz/v2
15
- description: Main (production) server
16
-
17
- tags:
18
- - name: 🚧 Traffic Restrictions
19
- description: >-
20
- 💡 NDIC Traffic Restrictions API for Intermodal Route Planner
21
-
22
- paths:
23
- /traffic/restrictions:
24
- get:
25
- summary: GET All Traffic Restrictions for a specific moment
26
- description: ""
27
- tags:
28
- - 🚧 Traffic Restrictions
29
- operationId: getTrafficRestrictions
30
- parameters:
31
- - name: moment
32
- in: query
33
- description: >-
34
- Get restrictions valid on given moment. ISO8601 format.
35
- required: false
36
- schema:
37
- type: string
38
- example: 2021-06-21T10:00Z
39
- - name: situationRecordType
40
- in: query
41
- description: >-
42
- Situation Record Type
43
- required: false
44
- schema:
45
- type: string
46
- example: "MaintenanceWorks"
47
- - name: limit
48
- in: query
49
- description: >-
50
- Limits number of retrieved items. The maximum is 10000 (default
51
- value)
52
- required: false
53
- schema:
54
- type: integer
55
- format: int64
56
- example: 10
57
- - name: offset
58
- in: query
59
- description: Sets offset for pagination. Combine with limit accordingly.
60
- required: false
61
- schema:
62
- type: integer
63
- format: int64
64
- example: 0
65
- responses:
66
- "200":
67
- description: successful operation
68
- content:
69
- application/json:
70
- schema:
71
- $ref: "#/components/schemas/TrafficRestrictionsPublication"
72
- "401":
73
- $ref: "#/components/responses/UnauthorizedError"
74
- "404":
75
- description: Not found
76
-
77
- components:
78
- responses:
79
- UnauthorizedError:
80
- description: API key is missing or invalid
81
- headers:
82
- WWW_Authenticate:
83
- schema:
84
- type: string
85
-
86
- schemas:
87
- TrafficRestrictionsPublication:
88
- type: object
89
- properties:
90
- modelBaseVersion:
91
- type: string
92
- example: 2
93
- situationPublicationLight:
94
- type: object
95
- properties:
96
- lang:
97
- type: string
98
- example: cs
99
- publicationTime:
100
- type: string
101
- example: "2021-06-21T10:00:37.000Z"
102
- publicationCreator:
103
- type: object
104
- properties:
105
- country:
106
- type: string
107
- example: cz
108
- nationalIdentifier:
109
- type: string
110
- example: DIC
111
- situation:
112
- type: array
113
- items:
114
- $ref: "#/components/schemas/TrafficRestrictionsSituation"
115
-
116
- TrafficRestrictionsSituation:
117
- type: object
118
- properties:
119
- id:
120
- type: string
121
- example: d5321261-0cf1-47ae-a1d6-39cb8aab3874
122
- version:
123
- type: integer
124
- format: int64
125
- example: 10
126
- situationRecord:
127
- type: array
128
- items:
129
- $ref: "#/components/schemas/TrafficRestrictionsSituationRecord"
130
-
131
- TrafficRestrictionsSituationRecord:
132
- type: object
133
- properties:
134
- situationRecordCreationTime:
135
- type: string
136
- example: "2021-06-21T10:00:37.000Z"
137
- situationRecordVersionTime:
138
- type: string
139
- example: "2021-06-21T10:00:37.000Z"
140
- startTime:
141
- type: string
142
- example: "2021-06-21T10:00:37.000Z"
143
- endTime:
144
- type: string
145
- example: "2021-06-28T10:00:37.000Z"
146
- type:
147
- type: string
148
- example: GeneralObstruction
149
- version:
150
- type: integer
151
- format: int64
152
- example: 1
153
- generalPublicComment:
154
- type: object
155
- properties:
156
- cs:
157
- type: string
158
- example: Od 27.7.2021 10:50 do 11:55; v ulici K Barrandovu v obci Praha; porouchané vozidlo
159
- sourceName:
160
- type: string
161
- example: PCR
162
- impact:
163
- type: object
164
- properties:
165
- delays:
166
- type: object
167
- properties:
168
- type:
169
- type: string
170
- nullable: true
171
- example: delays
172
- timeValue:
173
- type: integer
174
- format: int64
175
- nullable: true
176
- example: 3600
177
- numberOfLanesRestricted:
178
- type: integer
179
- format: int64
180
- example: 1
181
- numberOfOperationalLanes:
182
- type: integer
183
- format: int64
184
- example: 1
185
- trafficConstructionType:
186
- type: string
187
- example: lanesBlocked
188
- alertCLinear:
189
- type: object
190
- properties:
191
- type:
192
- type: string
193
- nullable: true
194
- example: AlertCMethod2Linear
195
- alertCLocationCountryCode:
196
- type: string
197
- nullable: true
198
- example: CZ
199
- alertCLocationTableNumber:
200
- type: string
201
- nullable: true
202
- example: 25
203
- alertCLocationTableVersion:
204
- type: string
205
- nullable: true
206
- example: "8.0"
207
- alertCDirection:
208
- type: object
209
- properties:
210
- alertCDirectionCoded:
211
- type: string
212
- nullable: true
213
- example: negative
214
- alertCMethod2PrimaryPointLocation:
215
- type: object
216
- properties:
217
- alertCLocation:
218
- type: object
219
- properties:
220
- specificLocation:
221
- type: string
222
- example: 1406
223
- alertCMethod2SecondaryPointLocation:
224
- type: object
225
- properties:
226
- alertCLocation:
227
- type: object
228
- properties:
229
- specificLocation:
230
- type: string
231
- example: 1406
232
- osmPath:
233
- type: array
234
- nullable: true
235
- items:
236
- type: number
237
- example: 32948103
1
+ openapi: 3.0.3
2
+ info:
3
+ title: 🚧 NDIC
4
+ description: >-
5
+ version: 1.0.0
6
+ contact:
7
+ name: Golemio Prague Data Plaform
8
+ email: golemio@operatorict.cz
9
+ url: https://golemio.cz
10
+
11
+ servers:
12
+ - url: https://rabin.golemio.cz/v2
13
+ description: Test (development) server
14
+ - url: https://api.golemio.cz/v2
15
+ description: Main (production) server
16
+
17
+ tags:
18
+ - name: 🚧 Traffic Restrictions
19
+ description: >-
20
+ 💡 NDIC Traffic Restrictions API for Intermodal Route Planner
21
+
22
+ paths:
23
+ /traffic/restrictions:
24
+ get:
25
+ summary: GET All Traffic Restrictions for a specific moment
26
+ description: ""
27
+ tags:
28
+ - 🚧 Traffic Restrictions
29
+ operationId: getTrafficRestrictions
30
+ parameters:
31
+ - name: moment
32
+ in: query
33
+ description: >-
34
+ Get restrictions valid on given moment. ISO8601 format.
35
+ required: false
36
+ schema:
37
+ type: string
38
+ example: 2021-06-21T10:00Z
39
+ - name: situationRecordType
40
+ in: query
41
+ description: >-
42
+ Situation Record Type
43
+ required: false
44
+ schema:
45
+ type: string
46
+ example: "MaintenanceWorks"
47
+ - name: limit
48
+ in: query
49
+ description: >-
50
+ Limits number of retrieved items. The maximum is 10000 (default
51
+ value)
52
+ required: false
53
+ schema:
54
+ type: integer
55
+ format: int64
56
+ example: 10
57
+ - name: offset
58
+ in: query
59
+ description: Sets offset for pagination. Combine with limit accordingly.
60
+ required: false
61
+ schema:
62
+ type: integer
63
+ format: int64
64
+ example: 0
65
+ responses:
66
+ "200":
67
+ description: successful operation
68
+ content:
69
+ application/json:
70
+ schema:
71
+ $ref: "#/components/schemas/TrafficRestrictionsPublication"
72
+ "401":
73
+ $ref: "#/components/responses/UnauthorizedError"
74
+ "404":
75
+ description: Not found
76
+
77
+ components:
78
+ responses:
79
+ UnauthorizedError:
80
+ description: API key is missing or invalid
81
+ headers:
82
+ WWW_Authenticate:
83
+ schema:
84
+ type: string
85
+
86
+ schemas:
87
+ TrafficRestrictionsPublication:
88
+ type: object
89
+ properties:
90
+ modelBaseVersion:
91
+ type: string
92
+ example: 2
93
+ situationPublicationLight:
94
+ type: object
95
+ properties:
96
+ lang:
97
+ type: string
98
+ example: cs
99
+ publicationTime:
100
+ type: string
101
+ example: "2021-06-21T10:00:37.000Z"
102
+ publicationCreator:
103
+ type: object
104
+ properties:
105
+ country:
106
+ type: string
107
+ example: cz
108
+ nationalIdentifier:
109
+ type: string
110
+ example: DIC
111
+ situation:
112
+ type: array
113
+ items:
114
+ $ref: "#/components/schemas/TrafficRestrictionsSituation"
115
+
116
+ TrafficRestrictionsSituation:
117
+ type: object
118
+ properties:
119
+ id:
120
+ type: string
121
+ example: d5321261-0cf1-47ae-a1d6-39cb8aab3874
122
+ version:
123
+ type: integer
124
+ format: int64
125
+ example: 10
126
+ situationRecord:
127
+ type: array
128
+ items:
129
+ $ref: "#/components/schemas/TrafficRestrictionsSituationRecord"
130
+
131
+ TrafficRestrictionsSituationRecord:
132
+ type: object
133
+ properties:
134
+ situationRecordCreationTime:
135
+ type: string
136
+ example: "2021-06-21T10:00:37.000Z"
137
+ situationRecordVersionTime:
138
+ type: string
139
+ example: "2021-06-21T10:00:37.000Z"
140
+ startTime:
141
+ type: string
142
+ example: "2021-06-21T10:00:37.000Z"
143
+ endTime:
144
+ type: string
145
+ example: "2021-06-28T10:00:37.000Z"
146
+ type:
147
+ type: string
148
+ example: GeneralObstruction
149
+ version:
150
+ type: integer
151
+ format: int64
152
+ example: 1
153
+ generalPublicComment:
154
+ type: object
155
+ properties:
156
+ cs:
157
+ type: string
158
+ example: Od 27.7.2021 10:50 do 11:55; v ulici K Barrandovu v obci Praha; porouchané vozidlo
159
+ sourceName:
160
+ type: string
161
+ example: PCR
162
+ impact:
163
+ type: object
164
+ properties:
165
+ delays:
166
+ type: object
167
+ properties:
168
+ type:
169
+ type: string
170
+ nullable: true
171
+ example: delays
172
+ timeValue:
173
+ type: integer
174
+ format: int64
175
+ nullable: true
176
+ example: 3600
177
+ numberOfLanesRestricted:
178
+ type: integer
179
+ format: int64
180
+ example: 1
181
+ numberOfOperationalLanes:
182
+ type: integer
183
+ format: int64
184
+ example: 1
185
+ trafficConstructionType:
186
+ type: string
187
+ example: lanesBlocked
188
+ alertCLinear:
189
+ type: object
190
+ properties:
191
+ type:
192
+ type: string
193
+ nullable: true
194
+ example: AlertCMethod2Linear
195
+ alertCLocationCountryCode:
196
+ type: string
197
+ nullable: true
198
+ example: CZ
199
+ alertCLocationTableNumber:
200
+ type: string
201
+ nullable: true
202
+ example: 25
203
+ alertCLocationTableVersion:
204
+ type: string
205
+ nullable: true
206
+ example: "8.0"
207
+ alertCDirection:
208
+ type: object
209
+ properties:
210
+ alertCDirectionCoded:
211
+ type: string
212
+ nullable: true
213
+ example: negative
214
+ alertCMethod2PrimaryPointLocation:
215
+ type: object
216
+ properties:
217
+ alertCLocation:
218
+ type: object
219
+ properties:
220
+ specificLocation:
221
+ type: string
222
+ example: 1406
223
+ alertCMethod2SecondaryPointLocation:
224
+ type: object
225
+ properties:
226
+ alertCLocation:
227
+ type: object
228
+ properties:
229
+ specificLocation:
230
+ type: string
231
+ example: 1406
232
+ osmPath:
233
+ type: array
234
+ nullable: true
235
+ items:
236
+ type: number
237
+ example: 32948103
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@golemio/ndic",
3
- "version": "1.2.0",
3
+ "version": "1.2.1-dev.986624454",
4
4
  "description": "Golemio NDIC Module",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -10,8 +10,9 @@
10
10
  "build-watch": "run-s 'build -- --watch --preserveWatchOutput'",
11
11
  "pretest": "golemio import-db-data --postgres",
12
12
  "test": "cross-env NODE_ENV=test mocha --exit --check-leaks --timeout 120000 -r ts-node/register -r tsconfig-paths/register -r dotenv/config --file 'test/setup.ts' 'test/**/*.test.ts'",
13
- "apidocs-test": "npm run apidocs-test-output",
14
- "apidocs-test-output": "cross-env NODE_ENV=test golemio swagger api-test --oas docs/openapi.yaml --script test/api-docs/output-gateway/server.js",
13
+ "apidocs-test": "npm run apidocs-test-output && npm run apidocs-test-input",
14
+ "apidocs-test-input": "cross-env NODE_ENV=test golemio swagger api-test --oas docs/openapi-input.yaml --script test/api-docs/input-gateway/server.js",
15
+ "apidocs-test-output": "cross-env NODE_ENV=test golemio swagger api-test --oas docs/openapi-output.yaml --script test/api-docs/output-gateway/server.js",
15
16
  "test-debug": "run-s 'test -- --inspect-brk=9230'",
16
17
  "code-coverage": "nyc run-s 'test -- -r source-map-support/register'",
17
18
  "generate-docs": "typedoc --out docs/typedoc src",