@golemio/flow 1.3.3-rc.1510392518 → 1.3.3-rc.1848328152

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.
@@ -134,7 +134,7 @@ Popis output-api.
134
134
  ### Obecné
135
135
 
136
136
  - OpenAPI v3 dokumentace
137
- - [odkaz na dokumentaci](./openapi.yaml)
137
+ - [odkaz na dokumentaci](openapi-output.yaml)
138
138
  - veřejné / neveřejné endpointy
139
139
  - api je neveřejné
140
140
 
@@ -33,12 +33,14 @@ paths:
33
33
  schema:
34
34
  type: integer
35
35
  format: int64
36
+ example: 1
36
37
  - name: locationName
37
38
  in: query
38
39
  description: Lists only locations with this NAME
39
40
  required: false
40
41
  schema:
41
42
  type: string
43
+ example: "Výstaviště - viadukt VO 2"
42
44
  - name: limit
43
45
  in: query
44
46
  description: Limits number of retrieved items
@@ -46,6 +48,7 @@ paths:
46
48
  schema:
47
49
  type: integer
48
50
  format: int64
51
+ example: 5
49
52
  - name: offset
50
53
  in: query
51
54
  description: Number of the first items that are skipped
@@ -53,6 +56,7 @@ paths:
53
56
  schema:
54
57
  type: integer
55
58
  format: int64
59
+ example: 0
56
60
  responses:
57
61
  "200":
58
62
  description: successful operation
@@ -65,7 +69,9 @@ paths:
65
69
  content:
66
70
  application/json:
67
71
  schema:
68
- $ref: "#/components/schemas/PedestriansLocation"
72
+ type: array
73
+ items:
74
+ $ref: "#/components/schemas/PedestriansLocation"
69
75
  "401":
70
76
  $ref: "#/components/responses/UnauthorizedError"
71
77
  "404":
@@ -83,17 +89,15 @@ paths:
83
89
  description: Lists only measurements for this location
84
90
  required: false
85
91
  schema:
86
- type: integer
87
- format: int64
88
- example: 0
92
+ type: string
93
+ example: wifi1
89
94
  - name: directionId
90
95
  in: query
91
96
  description: Lists only measurements for this direction
92
97
  required: false
93
98
  schema:
94
- type: integer
95
- format: int64
96
- example: 4
99
+ type: string
100
+ example: dir2
97
101
  - name: limit
98
102
  in: query
99
103
  description: Limits number of retrieved items
@@ -101,7 +105,7 @@ paths:
101
105
  schema:
102
106
  type: integer
103
107
  format: int64
104
- example: 1
108
+ example: 2
105
109
  - name: offset
106
110
  in: query
107
111
  description: Number of the first items that are skipped
@@ -109,7 +113,7 @@ paths:
109
113
  schema:
110
114
  type: integer
111
115
  format: int64
112
- example: 1
116
+ example: 0
113
117
  - name: from
114
118
  in: query
115
119
  description: Date in ISO8601, limits data measured from this datetime
@@ -117,7 +121,7 @@ paths:
117
121
  schema:
118
122
  type: string
119
123
  format: date
120
- example: 2020-09-01T01:15:00.000Z
124
+ example: 2020-11-24T10:30:00.000Z
121
125
  - name: to
122
126
  in: query
123
127
  description: Date in ISO8601, limits data measured up until this datetime
@@ -125,7 +129,7 @@ paths:
125
129
  schema:
126
130
  type: string
127
131
  format: date
128
- example: 2020-10-22T01:15:00.000Z
132
+ example: 2020-11-24T10:45:00.000Z
129
133
  responses:
130
134
  "200":
131
135
  description: successful operation
@@ -138,7 +142,9 @@ paths:
138
142
  content:
139
143
  application/json:
140
144
  schema:
141
- $ref: "#/components/schemas/PedestriansMeasurement"
145
+ type: array
146
+ items:
147
+ $ref: "#/components/schemas/PedestriansMeasurement"
142
148
  "401":
143
149
  $ref: "#/components/responses/UnauthorizedError"
144
150
  "404":
@@ -187,12 +193,11 @@ components:
187
193
  example: https://storage.golemio.cz/intenzita-pesi-dopravy/2.png
188
194
  measurement_start:
189
195
  type: string
190
- format: date
191
196
  example: 2020-09-02 12:00
192
197
  measurement_end:
193
198
  type: string
194
- format: date
195
199
  example: 2020-09-05 12:00
200
+ nullable: true
196
201
  directions:
197
202
  type: array
198
203
  items:
@@ -213,8 +218,7 @@ components:
213
218
  type: object
214
219
  properties:
215
220
  id:
216
- type: integer
217
- format: int64
221
+ type: string
218
222
  example: "2"
219
223
  name:
220
224
  type: string
@@ -222,7 +226,7 @@ components:
222
226
  to:
223
227
  type: integer
224
228
  format: int64
225
- example: "1"
229
+ example: 1
226
230
  required:
227
231
  - id
228
232
  - name
@@ -245,11 +249,11 @@ components:
245
249
  example: "1.00000000000000000000"
246
250
  measured_from:
247
251
  type: string
248
- format: date
252
+ format: date-time
249
253
  example: 2020-08-21T17:30:00.000Z
250
254
  measured_to:
251
255
  type: string
252
- format: date
256
+ format: date-time
253
257
  example: 2020-08-21T17:45:00.000Z
254
258
  required:
255
259
  - location_id
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@golemio/flow",
3
- "version": "1.3.3-rc.1510392518",
3
+ "version": "1.3.3-rc.1848328152",
4
4
  "description": "Golemio Flow Module",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -13,6 +13,8 @@
13
13
  "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'",
14
14
  "test-debug": "run-s 'test -- --inspect-brk=9230'",
15
15
  "code-coverage": "nyc run-s 'test -- -r source-map-support/register'",
16
+ "apidocs-test": "npm run apidocs-test-output",
17
+ "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 --config test/api-docs/output-gateway/portman-config.json",
16
18
  "generate-docs": "typedoc --out docs/typedoc src",
17
19
  "lint": "eslint \"{src,test}/**/*.ts\""
18
20
  },
@@ -30,9 +32,10 @@
30
32
  "npm": ">=8.0.0"
31
33
  },
32
34
  "devDependencies": {
35
+ "@apideck/portman": "^1.26.5",
33
36
  "@commitlint/cli": "^11.0.0",
34
37
  "@commitlint/config-conventional": "^11.0.0",
35
- "@golemio/cli": "1.7.3",
38
+ "@golemio/cli": "1.9.2",
36
39
  "@golemio/core": "1.15.0",
37
40
  "@golemio/db-common": "1.1.4",
38
41
  "@golemio/eslint-config": "1.1.2",