@golemio/gardens 1.2.8 → 1.2.10-dev.1566180827

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 (5) hide show
  1. package/docs/asyncapi.yaml +27 -0
  2. package/docs/implementation_documentation.md +2 -0
  3. package/docs/index.md +3 -0
  4. package/docs/openapi.yaml +274 -274
  5. package/package.json +1 -1
package/docs/asyncapi.yaml ADDED
@@ -0,0 +1,27 @@
1
+ asyncapi: "3.0.0"
2
+ info:
3
+ title: Public Gardens
4
+ version: "1.0.0"
5
+ description: Gardens module saves data of public gardens in the city of Prague.
6
+ channels:
7
+ gardens.refreshDataInDB:
8
+ address: dataplatform.gardens.refreshDataInDB
9
+ description: updates the data in the gardens table regarding the public gardens in Prague
10
+ bindings:
11
+ amqp:
12
+ is: queue
13
+ queue:
14
+ durable: true
15
+ messages:
16
+ empty:
17
+ $ref: "#/components/messages/emptyMessage"
18
+ operations:
19
+ gardens.refreshDataInDB:
20
+ action: "send"
21
+ channel:
22
+ $ref: "#/channels/gardens.refreshDataInDB"
23
+
24
+ components:
25
+ messages:
26
+ emptyMessage:
27
+ title: Empty message
package/docs/implementation_documentation.md CHANGED
@@ -55,6 +55,8 @@ Modul slouží k ukládání a poskytování informací o Gardens.
55
55
  - api je veřejné
56
56
  - postman kolekce
57
57
  - TBD
58
+ - Asyncapi dokumentace RabbitMQ front
59
+ - [AsyncAPI](./asyncapi.yaml)
58
60
 
59
61
  #### /gardens
60
62
 
package/docs/index.md ADDED
@@ -0,0 +1,3 @@
1
+ # @golemio/gardens
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,274 +1,274 @@
1
- openapi: 3.0.3
2
-
3
- info:
4
- title: 🌳 Gardens
5
- description: Locations and Description of Gardens
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: 🌳 Gardens (v2)
20
- description: <img src="https://img.shields.io/badge/opendata-available-green" alt="golemioapi-opendata-badge" /> 💡 Locations and Description of Gardens
21
-
22
- paths:
23
- /v2/gardens:
24
- get:
25
- summary: GET All Gardens
26
- operationId: GETAllGardens
27
- description: ""
28
- tags:
29
- - 🌳 Gardens (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/Garden"
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/gardens/{id}:
125
- get:
126
- summary: GET Gardens
127
- operationId: GETGardens
128
- description: ""
129
- tags:
130
- - 🌳 Gardens (v2)
131
- parameters:
132
- - name: id
133
- in: path
134
- description: Identifier of the garden.
135
- required: true
136
- example: bertramka
137
- schema:
138
- type: string
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/Garden"
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
- components:
196
- responses:
197
- UnauthorizedError:
198
- description: API key is missing or invalid
199
- headers:
200
- WWW_Authenticate:
201
- schema:
202
- type: string
203
- schemas:
204
- Garden:
205
- type: object
206
- properties:
207
- geometry:
208
- type: object
209
- properties:
210
- type:
211
- type: string
212
- example: Point
213
- coordinates:
214
- type: array
215
- items:
216
- type: number
217
- example:
218
- - 14.4633
219
- - 50.07827
220
- properties:
221
- type: object
222
- properties:
223
- address:
224
- type: object
225
- properties:
226
- address_formatted:
227
- type: string
228
- example: Dělnická 213/10, 17000 Praha-Holešovice, Česko
229
- description:
230
- type: string
231
- example: Mozartova busta v zahradě legendární usedlosti stojí na vyvýšeném místě.
232
- district:
233
- type: string
234
- example: praha-15
235
- id:
236
- type: string
237
- example: bertramka
238
- image:
239
- type: object
240
- properties:
241
- url:
242
- type: string
243
- example: http://www.praha.eu/public/5c/7c/31/96820_4_bertramka_08.jpg
244
- name:
245
- type: string
246
- example: Bertramka
247
- properties:
248
- type: array
249
- items:
250
- type: object
251
- properties:
252
- id:
253
- type: string
254
- example: doba
255
- description:
256
- type: string
257
- example: Otevírací doba
258
- value:
259
- type: string
260
- example: Celoročně duben až říjen 9-18 hod., listopad až březen 9:30-16 hod.
261
- required:
262
- - id
263
- updated_at:
264
- type: string
265
- example: "2019-05-18T07:38:37.000Z"
266
- url:
267
- type: string
268
- example: http://www.praha.eu/jnp/cz/co_delat_v_praze/parky/bertramka/bertramka_text.html
269
- required:
270
- - id
271
- - name
272
- type:
273
- type: string
274
- example: Feature
1
+ openapi: 3.0.3
2
+
3
+ info:
4
+ title: 🌳 Gardens
5
+ description: Locations and Description of Gardens
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: 🌳 Gardens (v2)
20
+ description: <img src="https://img.shields.io/badge/opendata-available-green" alt="golemioapi-opendata-badge" /> 💡 Locations and Description of Gardens
21
+
22
+ paths:
23
+ /v2/gardens:
24
+ get:
25
+ summary: GET All Gardens
26
+ operationId: GETAllGardens
27
+ description: ""
28
+ tags:
29
+ - 🌳 Gardens (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/Garden"
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/gardens/{id}:
125
+ get:
126
+ summary: GET Gardens
127
+ operationId: GETGardens
128
+ description: ""
129
+ tags:
130
+ - 🌳 Gardens (v2)
131
+ parameters:
132
+ - name: id
133
+ in: path
134
+ description: Identifier of the garden.
135
+ required: true
136
+ example: bertramka
137
+ schema:
138
+ type: string
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/Garden"
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
+ components:
196
+ responses:
197
+ UnauthorizedError:
198
+ description: API key is missing or invalid
199
+ headers:
200
+ WWW_Authenticate:
201
+ schema:
202
+ type: string
203
+ schemas:
204
+ Garden:
205
+ type: object
206
+ properties:
207
+ geometry:
208
+ type: object
209
+ properties:
210
+ type:
211
+ type: string
212
+ example: Point
213
+ coordinates:
214
+ type: array
215
+ items:
216
+ type: number
217
+ example:
218
+ - 14.4633
219
+ - 50.07827
220
+ properties:
221
+ type: object
222
+ properties:
223
+ address:
224
+ type: object
225
+ properties:
226
+ address_formatted:
227
+ type: string
228
+ example: Dělnická 213/10, 17000 Praha-Holešovice, Česko
229
+ description:
230
+ type: string
231
+ example: Mozartova busta v zahradě legendární usedlosti stojí na vyvýšeném místě.
232
+ district:
233
+ type: string
234
+ example: praha-15
235
+ id:
236
+ type: string
237
+ example: bertramka
238
+ image:
239
+ type: object
240
+ properties:
241
+ url:
242
+ type: string
243
+ example: http://www.praha.eu/public/5c/7c/31/96820_4_bertramka_08.jpg
244
+ name:
245
+ type: string
246
+ example: Bertramka
247
+ properties:
248
+ type: array
249
+ items:
250
+ type: object
251
+ properties:
252
+ id:
253
+ type: string
254
+ example: doba
255
+ description:
256
+ type: string
257
+ example: Otevírací doba
258
+ value:
259
+ type: string
260
+ example: Celoročně duben až říjen 9-18 hod., listopad až březen 9:30-16 hod.
261
+ required:
262
+ - id
263
+ updated_at:
264
+ type: string
265
+ example: "2019-05-18T07:38:37.000Z"
266
+ url:
267
+ type: string
268
+ example: http://www.praha.eu/jnp/cz/co_delat_v_praze/parky/bertramka/bertramka_text.html
269
+ required:
270
+ - id
271
+ - name
272
+ type:
273
+ type: string
274
+ example: Feature
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@golemio/gardens",
3
- "version": "1.2.8",
3
+ "version": "1.2.10-dev.1566180827",
4
4
  "description": "Golemio Gardens Module",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",