@golemio/playgrounds 1.0.5-dev.568980668 → 1.0.6-dev.585620225

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 (2) hide show
  1. package/docs/openapi.yaml +324 -0
  2. package/package.json +2 -2
@@ -0,0 +1,324 @@
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 Plaform
9
+ email: golemio@operatorict.cz
10
+ url: https://golemio.cz
11
+
12
+ servers:
13
+ - url: https://api.golemio.cz/v2
14
+ description: Main (production) server
15
+ - url: https://rabin.golemio.cz/v2
16
+ description: Test (development) server
17
+
18
+ tags:
19
+ - name: 🏸 Playgrounds
20
+ description: 💡 Locations and Description of Playgrounds
21
+
22
+ paths:
23
+ /playgrounds/:
24
+ get:
25
+ summary: GET All Playgrounds
26
+ operationId: GETAllPlaygrounds
27
+ description: ""
28
+ tags:
29
+ - 🏸 Playgrounds
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
+ content:
82
+ application/json; charset=utf-8:
83
+ schema:
84
+ type: object
85
+ properties:
86
+ type:
87
+ type: string
88
+ example: FeatureCollection
89
+ features:
90
+ type: array
91
+ items:
92
+ $ref: "#/components/schemas/Playground"
93
+ required:
94
+ - type
95
+
96
+ "401":
97
+ $ref: "#/components/responses/UnauthorizedError"
98
+ "403":
99
+ description: Forbidden
100
+ headers: {}
101
+ content:
102
+ application/json; charset=utf-8:
103
+ schema:
104
+ type: object
105
+ properties:
106
+ error_message:
107
+ type: string
108
+ error_status:
109
+ type: number
110
+ required:
111
+ - error_message
112
+ - error_status
113
+ examples:
114
+ response:
115
+ value:
116
+ error_message: Forbidden
117
+ error_status: 403
118
+
119
+ /playgrounds/{id}:
120
+ get:
121
+ summary: GET Playground
122
+ operationId: GETPlaygrounds
123
+ description: ""
124
+ tags:
125
+ - 🏸 Playgrounds
126
+ parameters:
127
+ - name: id
128
+ in: path
129
+ description: Identifier of the playground.
130
+ required: true
131
+ example: 2
132
+ schema:
133
+ type: number
134
+ responses:
135
+ "200":
136
+ description: OK
137
+ headers: {}
138
+ content:
139
+ application/json; charset=utf-8:
140
+ schema:
141
+ $ref: "#/components/schemas/Playground"
142
+ "401":
143
+ $ref: "#/components/responses/UnauthorizedError"
144
+ "403":
145
+ description: Forbidden
146
+ headers: {}
147
+ content:
148
+ application/json; charset=utf-8:
149
+ schema:
150
+ type: object
151
+ properties:
152
+ error_message:
153
+ type: string
154
+ error_status:
155
+ type: number
156
+ required:
157
+ - error_message
158
+ - error_status
159
+ examples:
160
+ response:
161
+ value:
162
+ error_message: Forbidden
163
+ error_status: 403
164
+ "404":
165
+ description: Not Found
166
+ headers: {}
167
+ content:
168
+ application/json; charset=utf-8:
169
+ schema:
170
+ type: object
171
+ properties:
172
+ error_message:
173
+ type: string
174
+ error_status:
175
+ type: number
176
+ required:
177
+ - error_message
178
+ - error_status
179
+ examples:
180
+ response:
181
+ value:
182
+ error_message: Not Found
183
+ error_status: 404
184
+
185
+ /playgrounds/properties:
186
+ get:
187
+ summary: GET All Playgrounds Properties
188
+ operationId: GETAllPlaygroundsProperties
189
+ description: ""
190
+ tags:
191
+ - 🏸 Playgrounds
192
+ responses:
193
+ "200":
194
+ description: OK
195
+ headers: {}
196
+ content:
197
+ application/json; charset=utf-8:
198
+ schema:
199
+ type: array
200
+ items:
201
+ $ref: "#/components/schemas/PlaygroundProperty"
202
+ "401":
203
+ $ref: "#/components/responses/UnauthorizedError"
204
+ "403":
205
+ description: Forbidden
206
+ headers: {}
207
+ content:
208
+ application/json; charset=utf-8:
209
+ schema:
210
+ type: object
211
+ properties:
212
+ error_message:
213
+ type: string
214
+ error_status:
215
+ type: number
216
+ required:
217
+ - error_message
218
+ - error_status
219
+ examples:
220
+ response:
221
+ value:
222
+ error_message: Forbidden
223
+ error_status: 403
224
+ components:
225
+ responses:
226
+ UnauthorizedError:
227
+ description: API key is missing or invalid
228
+ headers:
229
+ WWW_Authenticate:
230
+ schema:
231
+ type: string
232
+ schemas:
233
+ Playground:
234
+ type: object
235
+ properties:
236
+ geometry:
237
+ type: object
238
+ properties:
239
+ type:
240
+ type: string
241
+ example: Point
242
+ coordinates:
243
+ type: array
244
+ items:
245
+ type: number
246
+ example:
247
+ - 14.4633
248
+ - 50.07827
249
+ properties:
250
+ type: object
251
+ properties:
252
+ image:
253
+ type: object
254
+ properties:
255
+ url:
256
+ type: string
257
+ example: http://www.hristepraha.cz/images/img/2d73f6832f5ce39fc5987d27d9f4541fo.jpg
258
+ content:
259
+ type: string
260
+ 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...'
261
+ id:
262
+ type: number
263
+ example: 72
264
+ name:
265
+ type: string
266
+ example: Hostivařský lesopark (východní část) - hřiště 43.B
267
+ perex:
268
+ type: string
269
+ example: Trasa je vhodným polodenním rodinným výletem.
270
+ properties:
271
+ type: array
272
+ items:
273
+ $ref: "#/components/schemas/PlaygroundProperty"
274
+ updated_at:
275
+ type: string
276
+ example: "2019-05-18T07:38:37.000Z"
277
+ url:
278
+ type: string
279
+ example: http://www.hristepraha.cz/hriste/mapa/hostivarsky-lesopark-vychodni-cast-hriste-43-b
280
+ district:
281
+ type: string
282
+ example: praha-15
283
+ address:
284
+ type: object
285
+ properties:
286
+ address_formatted:
287
+ type: string
288
+ example: Dělnická 213/10, 17000 Praha-Holešovice, Česko
289
+ street_address:
290
+ type: string
291
+ example: Dělnická 213/10
292
+ postal_code:
293
+ type: string
294
+ example: 17000
295
+ address_locality:
296
+ type: string
297
+ example: Praha
298
+ address_region:
299
+ type: string
300
+ example: Holešovice
301
+ address_country:
302
+ type: string
303
+ example: Česko
304
+ required:
305
+ - content
306
+ - id
307
+ - name
308
+ - url
309
+ type:
310
+ type: string
311
+ example: Feature
312
+ PlaygroundProperty:
313
+ type: object
314
+ properties:
315
+ id:
316
+ type: number
317
+ example: 6
318
+ description:
319
+ type: string
320
+ example: WC na hřišti nebo v bezprostřední blízkosti
321
+ required:
322
+ - id
323
+
324
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@golemio/playgrounds",
3
- "version": "1.0.5-dev.568980668",
3
+ "version": "1.0.6-dev.585620225",
4
4
  "description": "Golemio Playgrounds Module",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -27,8 +27,8 @@
27
27
  "devDependencies": {
28
28
  "@commitlint/cli": "^11.0.0",
29
29
  "@commitlint/config-conventional": "^11.0.0",
30
- "@golemio/cli": "1.2.1",
31
30
  "@golemio/city-districts": "1.0.5",
31
+ "@golemio/cli": "1.2.1",
32
32
  "@golemio/core": "1.2.13",
33
33
  "@golemio/eslint-config": "^1.1.0",
34
34
  "@ovos-media/ts-transform-paths": "^1.7.18-1",