@golemio/playgrounds 1.1.12-dev.1384166960 → 1.1.12-rc.1441531670

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 (4) hide show
  1. package/docs/asyncapi.yaml +57 -0
  2. package/docs/index.md +3 -0
  3. package/docs/openapi.yaml +339 -339
  4. package/package.json +3 -3
package/docs/asyncapi.yaml ADDED
@@ -0,0 +1,57 @@
1
+ asyncapi: 3.0.0
2
+ info:
3
+ title: Playgrounds
4
+ version: 1.0.0
5
+ description: Playgrounds
6
+ channels:
7
+ updateAddressAndDistrictPlaygrounds:
8
+ address: dataplatform.playgrounds.updateAddressAndDistrict
9
+ description: adds address and district based on the coordinates
10
+ bindings:
11
+ amqp:
12
+ is: queue
13
+ queue:
14
+ exclusive: true
15
+ messages:
16
+ data:
17
+ $ref: "#/components/messages/updateAddressAndDistrict"
18
+ refreshDataInDBPlaygrounds:
19
+ address: dataplatform.playgrounds.refreshDataInDB
20
+ description: download new data and update the database
21
+ bindings:
22
+ amqp:
23
+ is: queue
24
+ queue:
25
+ exclusive: true
26
+ messages:
27
+ empty:
28
+ $ref: "#/components/messages/EmptyObject"
29
+ operations:
30
+ updateAddressAndDistrictPlaygrounds:
31
+ action: "send"
32
+ channel:
33
+ $ref: "#/channels/updateAddressAndDistrictPlaygrounds"
34
+ refreshDataInDBPlaygrounds:
35
+ action: "send"
36
+ channel:
37
+ $ref: "#/channels/refreshDataInDBPlaygrounds"
38
+ components:
39
+ messages:
40
+ EmptyObject:
41
+ payload:
42
+ type: object
43
+ updateAddressAndDistrict:
44
+ payload:
45
+ type: object
46
+ properties:
47
+ data:
48
+ type: object
49
+ $ref: "#/components/schemas/IPlaygroundInput"
50
+ additionalProperties: false
51
+ schemas:
52
+ IPlaygroundInput:
53
+ type: object
54
+ properties:
55
+ external_id:
56
+ type: number
57
+ additionalProperties: false
package/docs/index.md ADDED
@@ -0,0 +1,3 @@
1
+ # @golemio/playgrounds
2
+
3
+ This module is intended for use with Golemio services. Refer [here](https://gitlab.com/operator-ict/golemio/code/modules/core/-/blob/development/README.md) for further information on usage, local development and more.
package/docs/openapi.yaml CHANGED
@@ -1,339 +1,339 @@
1
- openapi: 3.0.3
2
-
3
- info:
4
- title: 🏸 Playgrounds
5
- description: Locations and Description of Playgrounds
6
- version: 1.0.0
7
- contact:
8
- name: Golemio Prague Data Platform
9
- email: golemio@operatorict.cz
10
- url: https://golemio.cz
11
-
12
- servers:
13
- - url: https://api.golemio.cz
14
- description: Main (production) server
15
- - url: https://rabin.golemio.cz
16
- description: Test (development) server
17
-
18
- tags:
19
- - name: 🏸 Playgrounds (v2)
20
- description: <img src="https://img.shields.io/badge/opendata-available-green" alt="golemioapi-opendata-badge" /> 💡 Locations and Description of Playgrounds
21
-
22
- paths:
23
- /v2/playgrounds:
24
- get:
25
- summary: GET All Playgrounds
26
- operationId: GETAllPlaygrounds
27
- description: ""
28
- tags:
29
- - 🏸 Playgrounds (v2)
30
- parameters:
31
- - name: latlng
32
- in: query
33
- description: Sorting by location (Latitude and Longitude separated by comma,
34
- latitude first).
35
- required: false
36
- example: 50.124935,14.457204
37
- schema:
38
- type: string
39
- - name: range
40
- in: query
41
- description: Filter by distance from latlng in meters (range query). Depends on
42
- the latlng parameter.
43
- required: false
44
- example: 5000
45
- schema:
46
- type: number
47
- - name: districts
48
- in: query
49
- description: Filter by Prague city districts (slug) separated by comma.
50
- required: false
51
- example: ['praha-4']
52
- schema:
53
- type: array
54
- items: {}
55
- - name: limit
56
- in: query
57
- description: Limits number of retrieved items. The maximum is 10000 (default
58
- value).
59
- required: false
60
- example: 10
61
- schema:
62
- type: number
63
- - name: offset
64
- in: query
65
- description: Number of the first items that are skipped.
66
- required: false
67
- example: 0
68
- schema:
69
- type: number
70
- - name: updatedSince
71
- in: query
72
- description: Filters all results with older updated_at than this parameter
73
- required: false
74
- example: 2019-05-18T07:38:37.000Z
75
- schema:
76
- type: string
77
- responses:
78
- "200":
79
- description: OK
80
- headers:
81
- Cache-Control:
82
- description: Cache control directive for caching proxies
83
- schema:
84
- type: string
85
- example: public, s-maxage=43200, stale-while-revalidate=3600
86
- content:
87
- application/json; charset=utf-8:
88
- schema:
89
- type: object
90
- properties:
91
- type:
92
- type: string
93
- example: FeatureCollection
94
- features:
95
- type: array
96
- items:
97
- $ref: "#/components/schemas/Playground"
98
- required:
99
- - type
100
-
101
- "401":
102
- $ref: "#/components/responses/UnauthorizedError"
103
- "403":
104
- description: Forbidden
105
- headers: {}
106
- content:
107
- application/json; charset=utf-8:
108
- schema:
109
- type: object
110
- properties:
111
- error_message:
112
- type: string
113
- error_status:
114
- type: number
115
- required:
116
- - error_message
117
- - error_status
118
- examples:
119
- response:
120
- value:
121
- error_message: Forbidden
122
- error_status: 403
123
-
124
- /v2/playgrounds/{id}:
125
- get:
126
- summary: GET Playground
127
- operationId: GETPlaygrounds
128
- description: ""
129
- tags:
130
- - 🏸 Playgrounds (v2)
131
- parameters:
132
- - name: id
133
- in: path
134
- description: Identifier of the playground.
135
- required: true
136
- example: 2
137
- schema:
138
- type: number
139
- responses:
140
- "200":
141
- description: OK
142
- headers:
143
- Cache-Control:
144
- description: Cache control directive for caching proxies
145
- schema:
146
- type: string
147
- example: public, s-maxage=43200, stale-while-revalidate=3600
148
- content:
149
- application/json; charset=utf-8:
150
- schema:
151
- $ref: "#/components/schemas/Playground"
152
- "401":
153
- $ref: "#/components/responses/UnauthorizedError"
154
- "403":
155
- description: Forbidden
156
- headers: {}
157
- content:
158
- application/json; charset=utf-8:
159
- schema:
160
- type: object
161
- properties:
162
- error_message:
163
- type: string
164
- error_status:
165
- type: number
166
- required:
167
- - error_message
168
- - error_status
169
- examples:
170
- response:
171
- value:
172
- error_message: Forbidden
173
- error_status: 403
174
- "404":
175
- description: Not Found
176
- headers: {}
177
- content:
178
- application/json; charset=utf-8:
179
- schema:
180
- type: object
181
- properties:
182
- error_message:
183
- type: string
184
- error_status:
185
- type: number
186
- required:
187
- - error_message
188
- - error_status
189
- examples:
190
- response:
191
- value:
192
- error_message: Not Found
193
- error_status: 404
194
-
195
- /v2/playgrounds/properties:
196
- get:
197
- summary: GET All Playgrounds Properties
198
- operationId: GETAllPlaygroundsProperties
199
- description: ""
200
- tags:
201
- - 🏸 Playgrounds (v2)
202
- responses:
203
- "200":
204
- description: OK
205
- headers:
206
- Cache-Control:
207
- description: Cache control directive for caching proxies
208
- schema:
209
- type: string
210
- example: public, s-maxage=43200, stale-while-revalidate=3600
211
- content:
212
- application/json; charset=utf-8:
213
- schema:
214
- type: array
215
- items:
216
- $ref: "#/components/schemas/PlaygroundProperty"
217
- "401":
218
- $ref: "#/components/responses/UnauthorizedError"
219
- "403":
220
- description: Forbidden
221
- headers: {}
222
- content:
223
- application/json; charset=utf-8:
224
- schema:
225
- type: object
226
- properties:
227
- error_message:
228
- type: string
229
- error_status:
230
- type: number
231
- required:
232
- - error_message
233
- - error_status
234
- examples:
235
- response:
236
- value:
237
- error_message: Forbidden
238
- error_status: 403
239
- components:
240
- responses:
241
- UnauthorizedError:
242
- description: API key is missing or invalid
243
- headers:
244
- WWW_Authenticate:
245
- schema:
246
- type: string
247
- schemas:
248
- Playground:
249
- type: object
250
- properties:
251
- geometry:
252
- type: object
253
- properties:
254
- type:
255
- type: string
256
- example: Point
257
- coordinates:
258
- type: array
259
- items:
260
- type: number
261
- example:
262
- - 14.4633
263
- - 50.07827
264
- properties:
265
- type: object
266
- properties:
267
- image:
268
- type: object
269
- properties:
270
- url:
271
- type: string
272
- example: http://www.hristepraha.cz/images/img/2d73f6832f5ce39fc5987d27d9f4541fo.jpg
273
- content:
274
- type: string
275
- example: 'Popis: Asi 300 m od prodejny Lidl v Hornoměcholupské ulici se na okraji louky rozkládá první hřiště (43.A). Tvoří ho...'
276
- id:
277
- type: number
278
- example: 72
279
- name:
280
- type: string
281
- example: Hostivařský lesopark (východní část) - hřiště 43.B
282
- perex:
283
- type: string
284
- example: Trasa je vhodným polodenním rodinným výletem.
285
- properties:
286
- type: array
287
- items:
288
- $ref: "#/components/schemas/PlaygroundProperty"
289
- updated_at:
290
- type: string
291
- example: "2019-05-18T07:38:37.000Z"
292
- url:
293
- type: string
294
- example: http://www.hristepraha.cz/hriste/mapa/hostivarsky-lesopark-vychodni-cast-hriste-43-b
295
- district:
296
- type: string
297
- example: praha-15
298
- address:
299
- type: object
300
- properties:
301
- address_formatted:
302
- type: string
303
- example: Dělnická 213/10, 17000 Praha-Holešovice, Česko
304
- street_address:
305
- type: string
306
- example: Dělnická 213/10
307
- postal_code:
308
- type: string
309
- example: 17000
310
- address_locality:
311
- type: string
312
- example: Praha
313
- address_region:
314
- type: string
315
- example: Holešovice
316
- address_country:
317
- type: string
318
- example: Česko
319
- required:
320
- - content
321
- - id
322
- - name
323
- - url
324
- type:
325
- type: string
326
- example: Feature
327
- PlaygroundProperty:
328
- type: object
329
- properties:
330
- id:
331
- type: number
332
- example: 6
333
- description:
334
- type: string
335
- example: WC na hřišti nebo v bezprostřední blízkosti
336
- required:
337
- - id
338
-
339
-
1
+ openapi: 3.0.3
2
+
3
+ info:
4
+ title: 🏸 Playgrounds
5
+ description: Locations and Description of Playgrounds
6
+ version: 1.0.0
7
+ contact:
8
+ name: Golemio Prague Data Platform
9
+ email: golemio@operatorict.cz
10
+ url: https://golemio.cz
11
+
12
+ servers:
13
+ - url: https://api.golemio.cz
14
+ description: Main (production) server
15
+ - url: https://rabin.golemio.cz
16
+ description: Test (development) server
17
+
18
+ tags:
19
+ - name: 🏸 Playgrounds (v2)
20
+ description: <img src="https://img.shields.io/badge/opendata-available-green" alt="golemioapi-opendata-badge" /> 💡 Locations and Description of Playgrounds
21
+
22
+ paths:
23
+ /v2/playgrounds:
24
+ get:
25
+ summary: GET All Playgrounds
26
+ operationId: GETAllPlaygrounds
27
+ description: ""
28
+ tags:
29
+ - 🏸 Playgrounds (v2)
30
+ parameters:
31
+ - name: latlng
32
+ in: query
33
+ description: Sorting by location (Latitude and Longitude separated by comma,
34
+ latitude first).
35
+ required: false
36
+ example: 50.124935,14.457204
37
+ schema:
38
+ type: string
39
+ - name: range
40
+ in: query
41
+ description: Filter by distance from latlng in meters (range query). Depends on
42
+ the latlng parameter.
43
+ required: false
44
+ example: 5000
45
+ schema:
46
+ type: number
47
+ - name: districts
48
+ in: query
49
+ description: Filter by Prague city districts (slug) separated by comma.
50
+ required: false
51
+ example: ['praha-4']
52
+ schema:
53
+ type: array
54
+ items: {}
55
+ - name: limit
56
+ in: query
57
+ description: Limits number of retrieved items. The maximum is 10000 (default
58
+ value).
59
+ required: false
60
+ example: 10
61
+ schema:
62
+ type: number
63
+ - name: offset
64
+ in: query
65
+ description: Number of the first items that are skipped.
66
+ required: false
67
+ example: 0
68
+ schema:
69
+ type: number
70
+ - name: updatedSince
71
+ in: query
72
+ description: Filters all results with older updated_at than this parameter
73
+ required: false
74
+ example: 2019-05-18T07:38:37.000Z
75
+ schema:
76
+ type: string
77
+ responses:
78
+ "200":
79
+ description: OK
80
+ headers:
81
+ Cache-Control:
82
+ description: Cache control directive for caching proxies
83
+ schema:
84
+ type: string
85
+ example: public, s-maxage=43200, stale-while-revalidate=3600
86
+ content:
87
+ application/json; charset=utf-8:
88
+ schema:
89
+ type: object
90
+ properties:
91
+ type:
92
+ type: string
93
+ example: FeatureCollection
94
+ features:
95
+ type: array
96
+ items:
97
+ $ref: "#/components/schemas/Playground"
98
+ required:
99
+ - type
100
+
101
+ "401":
102
+ $ref: "#/components/responses/UnauthorizedError"
103
+ "403":
104
+ description: Forbidden
105
+ headers: {}
106
+ content:
107
+ application/json; charset=utf-8:
108
+ schema:
109
+ type: object
110
+ properties:
111
+ error_message:
112
+ type: string
113
+ error_status:
114
+ type: number
115
+ required:
116
+ - error_message
117
+ - error_status
118
+ examples:
119
+ response:
120
+ value:
121
+ error_message: Forbidden
122
+ error_status: 403
123
+
124
+ /v2/playgrounds/{id}:
125
+ get:
126
+ summary: GET Playground
127
+ operationId: GETPlaygrounds
128
+ description: ""
129
+ tags:
130
+ - 🏸 Playgrounds (v2)
131
+ parameters:
132
+ - name: id
133
+ in: path
134
+ description: Identifier of the playground.
135
+ required: true
136
+ example: 2
137
+ schema:
138
+ type: number
139
+ responses:
140
+ "200":
141
+ description: OK
142
+ headers:
143
+ Cache-Control:
144
+ description: Cache control directive for caching proxies
145
+ schema:
146
+ type: string
147
+ example: public, s-maxage=43200, stale-while-revalidate=3600
148
+ content:
149
+ application/json; charset=utf-8:
150
+ schema:
151
+ $ref: "#/components/schemas/Playground"
152
+ "401":
153
+ $ref: "#/components/responses/UnauthorizedError"
154
+ "403":
155
+ description: Forbidden
156
+ headers: {}
157
+ content:
158
+ application/json; charset=utf-8:
159
+ schema:
160
+ type: object
161
+ properties:
162
+ error_message:
163
+ type: string
164
+ error_status:
165
+ type: number
166
+ required:
167
+ - error_message
168
+ - error_status
169
+ examples:
170
+ response:
171
+ value:
172
+ error_message: Forbidden
173
+ error_status: 403
174
+ "404":
175
+ description: Not Found
176
+ headers: {}
177
+ content:
178
+ application/json; charset=utf-8:
179
+ schema:
180
+ type: object
181
+ properties:
182
+ error_message:
183
+ type: string
184
+ error_status:
185
+ type: number
186
+ required:
187
+ - error_message
188
+ - error_status
189
+ examples:
190
+ response:
191
+ value:
192
+ error_message: Not Found
193
+ error_status: 404
194
+
195
+ /v2/playgrounds/properties:
196
+ get:
197
+ summary: GET All Playgrounds Properties
198
+ operationId: GETAllPlaygroundsProperties
199
+ description: ""
200
+ tags:
201
+ - 🏸 Playgrounds (v2)
202
+ responses:
203
+ "200":
204
+ description: OK
205
+ headers:
206
+ Cache-Control:
207
+ description: Cache control directive for caching proxies
208
+ schema:
209
+ type: string
210
+ example: public, s-maxage=43200, stale-while-revalidate=3600
211
+ content:
212
+ application/json; charset=utf-8:
213
+ schema:
214
+ type: array
215
+ items:
216
+ $ref: "#/components/schemas/PlaygroundProperty"
217
+ "401":
218
+ $ref: "#/components/responses/UnauthorizedError"
219
+ "403":
220
+ description: Forbidden
221
+ headers: {}
222
+ content:
223
+ application/json; charset=utf-8:
224
+ schema:
225
+ type: object
226
+ properties:
227
+ error_message:
228
+ type: string
229
+ error_status:
230
+ type: number
231
+ required:
232
+ - error_message
233
+ - error_status
234
+ examples:
235
+ response:
236
+ value:
237
+ error_message: Forbidden
238
+ error_status: 403
239
+ components:
240
+ responses:
241
+ UnauthorizedError:
242
+ description: API key is missing or invalid
243
+ headers:
244
+ WWW_Authenticate:
245
+ schema:
246
+ type: string
247
+ schemas:
248
+ Playground:
249
+ type: object
250
+ properties:
251
+ geometry:
252
+ type: object
253
+ properties:
254
+ type:
255
+ type: string
256
+ example: Point
257
+ coordinates:
258
+ type: array
259
+ items:
260
+ type: number
261
+ example:
262
+ - 14.4633
263
+ - 50.07827
264
+ properties:
265
+ type: object
266
+ properties:
267
+ image:
268
+ type: object
269
+ properties:
270
+ url:
271
+ type: string
272
+ example: http://www.hristepraha.cz/images/img/2d73f6832f5ce39fc5987d27d9f4541fo.jpg
273
+ content:
274
+ type: string
275
+ example: 'Popis: Asi 300 m od prodejny Lidl v Hornoměcholupské ulici se na okraji louky rozkládá první hřiště (43.A). Tvoří ho...'
276
+ id:
277
+ type: number
278
+ example: 72
279
+ name:
280
+ type: string
281
+ example: Hostivařský lesopark (východní část) - hřiště 43.B
282
+ perex:
283
+ type: string
284
+ example: Trasa je vhodným polodenním rodinným výletem.
285
+ properties:
286
+ type: array
287
+ items:
288
+ $ref: "#/components/schemas/PlaygroundProperty"
289
+ updated_at:
290
+ type: string
291
+ example: "2019-05-18T07:38:37.000Z"
292
+ url:
293
+ type: string
294
+ example: http://www.hristepraha.cz/hriste/mapa/hostivarsky-lesopark-vychodni-cast-hriste-43-b
295
+ district:
296
+ type: string
297
+ example: praha-15
298
+ address:
299
+ type: object
300
+ properties:
301
+ address_formatted:
302
+ type: string
303
+ example: Dělnická 213/10, 17000 Praha-Holešovice, Česko
304
+ street_address:
305
+ type: string
306
+ example: Dělnická 213/10
307
+ postal_code:
308
+ type: string
309
+ example: 17000
310
+ address_locality:
311
+ type: string
312
+ example: Praha
313
+ address_region:
314
+ type: string
315
+ example: Holešovice
316
+ address_country:
317
+ type: string
318
+ example: Česko
319
+ required:
320
+ - content
321
+ - id
322
+ - name
323
+ - url
324
+ type:
325
+ type: string
326
+ example: Feature
327
+ PlaygroundProperty:
328
+ type: object
329
+ properties:
330
+ id:
331
+ type: number
332
+ example: 6
333
+ description:
334
+ type: string
335
+ example: WC na hřišti nebo v bezprostřední blízkosti
336
+ required:
337
+ - id
338
+
339
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@golemio/playgrounds",
3
- "version": "1.1.12-dev.1384166960",
3
+ "version": "1.1.12-rc.1441531670",
4
4
  "description": "Golemio Playgrounds Module",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -32,8 +32,8 @@
32
32
  "@commitlint/cli": "^11.0.0",
33
33
  "@commitlint/config-conventional": "^11.0.0",
34
34
  "@golemio/city-districts": "1.3.0",
35
- "@golemio/cli": "1.5.0",
36
- "@golemio/core": "1.12.0",
35
+ "@golemio/cli": "1.6.3",
36
+ "@golemio/core": "1.13.3",
37
37
  "@golemio/db-common": "1.1.4",
38
38
  "@golemio/eslint-config": "1.1.2",
39
39
  "@types/chai": "4.2.3",