@golemio/municipal-authorities 1.2.0 → 1.2.2-rc.1450458255

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/index.md +3 -0
  2. package/docs/openapi.yaml +438 -438
  3. package/package.json +1 -1
package/docs/index.md ADDED
@@ -0,0 +1,3 @@
1
+ # @golemio/municipal-authorities
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,438 +1,438 @@
1
- openapi: 3.0.3
2
-
3
- info:
4
- title: 🏛 Municipal Authorities
5
- description: Locations and Description of Municipal Authorities
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: 🏛 Municipal Authorities (v2)
20
- description: <img src="https://img.shields.io/badge/opendata-available-green" alt="golemioapi-opendata-badge" /> 💡 Locations and Description of Municipal Authorities
21
-
22
- paths:
23
- /v2/municipalauthorities:
24
- get:
25
- summary: GET All Municipal Authorities
26
- operationId: GETAllMunicipalAuthorities
27
- description: ""
28
- tags:
29
- - 🏛 Municipal Authorities (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
-
56
- - name: type
57
- in: query
58
- description: Filter by group of types of the municipal authorities.
59
- required: false
60
- example: city-hall
61
- schema:
62
- type: string
63
- enum: [municipality, city-hall]
64
- - name: limit
65
- in: query
66
- description: Limits number of retrieved items. The maximum is 10000 (default
67
- value).
68
- required: false
69
- example: 10
70
- schema:
71
- type: number
72
- - name: offset
73
- in: query
74
- description: Number of the first items that are skipped.
75
- required: false
76
- example: 0
77
- schema:
78
- type: number
79
- - name: updatedSince
80
- in: query
81
- description: Filters all results with older updated_at than this parameter
82
- required: false
83
- example: 2019-05-18T07:38:37.000Z
84
- schema:
85
- type: string
86
- responses:
87
- "200":
88
- description: OK
89
- headers:
90
- Cache-Control:
91
- description: Cache control directive for caching proxies
92
- schema:
93
- type: string
94
- example: public, s-maxage=43200, stale-while-revalidate=3600
95
- content:
96
- application/json; charset=utf-8:
97
- schema:
98
- type: object
99
- properties:
100
- type:
101
- type: string
102
- example: FeatureCollection
103
- features:
104
- type: array
105
- items:
106
- $ref: "#/components/schemas/MunicipalAuthority"
107
- required:
108
- - type
109
-
110
- "401":
111
- $ref: "#/components/responses/UnauthorizedError"
112
- "403":
113
- description: Forbidden
114
- headers: {}
115
- content:
116
- application/json; charset=utf-8:
117
- schema:
118
- type: object
119
- properties:
120
- error_message:
121
- type: string
122
- error_status:
123
- type: number
124
- required:
125
- - error_message
126
- - error_status
127
- examples:
128
- response:
129
- value:
130
- error_message: Forbidden
131
- error_status: 403
132
-
133
- /v2/municipalauthorities/{id}:
134
- get:
135
- summary: GET Municipal Authority
136
- operationId: GETMunicipalAuthority
137
- description: ""
138
- tags:
139
- - 🏛 Municipal Authorities (v2)
140
- parameters:
141
- - name: id
142
- in: path
143
- description: Identifier of the municipal authority.
144
- required: true
145
- example: magistrat-hlavniho-mesta-prahy
146
- schema:
147
- type: string
148
- responses:
149
- "200":
150
- description: OK
151
- headers:
152
- Cache-Control:
153
- description: Cache control directive for caching proxies
154
- schema:
155
- type: string
156
- example: public, s-maxage=43200, stale-while-revalidate=3600
157
- content:
158
- application/json; charset=utf-8:
159
- schema:
160
- $ref: "#/components/schemas/MunicipalAuthority"
161
- "401":
162
- $ref: "#/components/responses/UnauthorizedError"
163
- "403":
164
- description: Forbidden
165
- headers: {}
166
- content:
167
- application/json; charset=utf-8:
168
- schema:
169
- type: object
170
- properties:
171
- error_message:
172
- type: string
173
- error_status:
174
- type: number
175
- required:
176
- - error_message
177
- - error_status
178
- examples:
179
- response:
180
- value:
181
- error_message: Forbidden
182
- error_status: 403
183
- "404":
184
- description: Not Found
185
- headers: {}
186
- content:
187
- application/json; charset=utf-8:
188
- schema:
189
- type: object
190
- properties:
191
- error_message:
192
- type: string
193
- error_status:
194
- type: number
195
- required:
196
- - error_message
197
- - error_status
198
- examples:
199
- response:
200
- value:
201
- error_message: Not Found
202
- error_status: 404
203
-
204
- /v2/municipalauthorities/{id}/queues:
205
- get:
206
- summary: GET All Municipal Authority Waiting Queues
207
- operationId: GETAllMunicipalAuthorityWaitingQueues
208
- description: ""
209
- tags:
210
- - 🏛 Municipal Authorities (v2)
211
- parameters:
212
- - name: id
213
- in: path
214
- description: Identifier of the municipality.
215
- required: true
216
- example: skoduv-palac
217
- schema:
218
- type: string
219
- responses:
220
- "200":
221
- description: OK
222
- headers:
223
- Cache-Control:
224
- description: Cache control directive for caching proxies
225
- schema:
226
- type: string
227
- example: public, s-maxage=43200, stale-while-revalidate=3600
228
- content:
229
- application/json; charset=utf-8:
230
- schema:
231
- $ref: "#/components/schemas/MunicipalAuthorityQueues"
232
- "401":
233
- $ref: "#/components/responses/UnauthorizedError"
234
- "403":
235
- description: Forbidden
236
- headers: {}
237
- content:
238
- application/json; charset=utf-8:
239
- schema:
240
- type: object
241
- properties:
242
- error_message:
243
- type: string
244
- error_status:
245
- type: number
246
- required:
247
- - error_message
248
- - error_status
249
- examples:
250
- response:
251
- value:
252
- error_message: Forbidden
253
- error_status: 403
254
- "404":
255
- description: Not Found
256
- headers: {}
257
- content:
258
- application/json; charset=utf-8:
259
- schema:
260
- type: object
261
- properties:
262
- error_message:
263
- type: string
264
- error_status:
265
- type: number
266
- required:
267
- - error_message
268
- - error_status
269
- examples:
270
- response:
271
- value:
272
- error_message: Not Found
273
- error_status: 404
274
-
275
- components:
276
- responses:
277
- UnauthorizedError:
278
- description: API key is missing or invalid
279
- headers:
280
- WWW_Authenticate:
281
- schema:
282
- type: string
283
- schemas:
284
- MunicipalAuthority:
285
- type: object
286
- properties:
287
- geometry:
288
- type: object
289
- properties:
290
- type:
291
- type: string
292
- example: Point
293
- coordinates:
294
- type: array
295
- items:
296
- type: number
297
- example:
298
- - 14.4633
299
- - 50.07827
300
- properties:
301
- type: object
302
- properties:
303
- image:
304
- type: object
305
- properties:
306
- mimetype:
307
- type: string
308
- example: image/png
309
- size:
310
- type: number
311
- example: 714603
312
- url:
313
- type: string
314
- example: https://www.mojepraha.eu/images/municipal-authorities/VJXPN4RVrTLnkih5.png
315
- email:
316
- type: array
317
- items:
318
- type: string
319
- example: posta@praha.eu
320
- telephone:
321
- type: array
322
- items:
323
- type: string
324
- example: "+420 777 7777"
325
- web:
326
- type: array
327
- items:
328
- type: string
329
- example: "www.praha.eu/"
330
- address:
331
- type: object
332
- properties:
333
- address_formatted:
334
- type: string
335
- example: Dělnická 213/10, 17000 Praha-Holešovice, Česko
336
- agendas:
337
- type: array
338
- items:
339
- type: object
340
- properties:
341
- keywords:
342
- type: array
343
- items:
344
- type: string
345
- example: "nebytové prostory"
346
- description:
347
- type: string
348
- example: Pronájem bytových a nebytových prostor
349
- long_description:
350
- type: string
351
- example: Ověřování shody opisu nebo kopie s listinou a ověřování pravosti podpisu
352
- district:
353
- type: string
354
- example: praha-15
355
- id:
356
- type: string
357
- example: magistrat-hlavniho-mesta-prahy
358
- name:
359
- type: string
360
- example: Magistrát hlavního města Prahy
361
- official_board:
362
- type: string
363
- example: "http://www.praha.eu/jnp/cz/o_meste/magistrat/deska/index.html"
364
- opening_hours:
365
- type: array
366
- items:
367
- type: object
368
- properties:
369
- closes:
370
- type: string
371
- example: "12:00"
372
- opens:
373
- type: string
374
- example: "08:00"
375
- day_of_week:
376
- type: string
377
- example: Monday
378
- description:
379
- type: string
380
- updated_at:
381
- type: string
382
- example: "2019-05-18T07:38:37.000Z"
383
- type:
384
- type: object
385
- properties:
386
- description:
387
- type: string
388
- example: Obecní úřad
389
- id:
390
- type: string
391
- example: municipality
392
- required:
393
- - id
394
- required:
395
- - id
396
- - name
397
- type:
398
- type: string
399
- example: Feature
400
- MunicipalAuthorityQueues:
401
- type: object
402
- properties:
403
- last_updated:
404
- type: string
405
- example: 2019+04-30T09:56:00+02:00
406
- municipal_authority_id:
407
- type: string
408
- example: skoduv-palac
409
- served_activities:
410
- type: array
411
- items:
412
- type: object
413
- properties:
414
- activity:
415
- type: string
416
- example: "OSV: CzechPoint"
417
- number_of_person_in_queue:
418
- type: number
419
- example: 0
420
- number_of_serving_counters:
421
- type: number
422
- example: 5
423
- required:
424
- - activity
425
- - number_of_person_in_queue
426
- - number_of_serving_counters
427
- updated_at:
428
- type: string
429
- example: "2019-04-30T09:56:00+02:00"
430
- title:
431
- type: string
432
- example: "Monitoring odbavování klientů ve Škodově paláci"
433
- required:
434
- - last_updated
435
- - municipal_authority_id
436
- - served_activities
437
- - updated_at
438
- - title
1
+ openapi: 3.0.3
2
+
3
+ info:
4
+ title: 🏛 Municipal Authorities
5
+ description: Locations and Description of Municipal Authorities
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: 🏛 Municipal Authorities (v2)
20
+ description: <img src="https://img.shields.io/badge/opendata-available-green" alt="golemioapi-opendata-badge" /> 💡 Locations and Description of Municipal Authorities
21
+
22
+ paths:
23
+ /v2/municipalauthorities:
24
+ get:
25
+ summary: GET All Municipal Authorities
26
+ operationId: GETAllMunicipalAuthorities
27
+ description: ""
28
+ tags:
29
+ - 🏛 Municipal Authorities (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
+
56
+ - name: type
57
+ in: query
58
+ description: Filter by group of types of the municipal authorities.
59
+ required: false
60
+ example: city-hall
61
+ schema:
62
+ type: string
63
+ enum: [municipality, city-hall]
64
+ - name: limit
65
+ in: query
66
+ description: Limits number of retrieved items. The maximum is 10000 (default
67
+ value).
68
+ required: false
69
+ example: 10
70
+ schema:
71
+ type: number
72
+ - name: offset
73
+ in: query
74
+ description: Number of the first items that are skipped.
75
+ required: false
76
+ example: 0
77
+ schema:
78
+ type: number
79
+ - name: updatedSince
80
+ in: query
81
+ description: Filters all results with older updated_at than this parameter
82
+ required: false
83
+ example: 2019-05-18T07:38:37.000Z
84
+ schema:
85
+ type: string
86
+ responses:
87
+ "200":
88
+ description: OK
89
+ headers:
90
+ Cache-Control:
91
+ description: Cache control directive for caching proxies
92
+ schema:
93
+ type: string
94
+ example: public, s-maxage=43200, stale-while-revalidate=3600
95
+ content:
96
+ application/json; charset=utf-8:
97
+ schema:
98
+ type: object
99
+ properties:
100
+ type:
101
+ type: string
102
+ example: FeatureCollection
103
+ features:
104
+ type: array
105
+ items:
106
+ $ref: "#/components/schemas/MunicipalAuthority"
107
+ required:
108
+ - type
109
+
110
+ "401":
111
+ $ref: "#/components/responses/UnauthorizedError"
112
+ "403":
113
+ description: Forbidden
114
+ headers: {}
115
+ content:
116
+ application/json; charset=utf-8:
117
+ schema:
118
+ type: object
119
+ properties:
120
+ error_message:
121
+ type: string
122
+ error_status:
123
+ type: number
124
+ required:
125
+ - error_message
126
+ - error_status
127
+ examples:
128
+ response:
129
+ value:
130
+ error_message: Forbidden
131
+ error_status: 403
132
+
133
+ /v2/municipalauthorities/{id}:
134
+ get:
135
+ summary: GET Municipal Authority
136
+ operationId: GETMunicipalAuthority
137
+ description: ""
138
+ tags:
139
+ - 🏛 Municipal Authorities (v2)
140
+ parameters:
141
+ - name: id
142
+ in: path
143
+ description: Identifier of the municipal authority.
144
+ required: true
145
+ example: magistrat-hlavniho-mesta-prahy
146
+ schema:
147
+ type: string
148
+ responses:
149
+ "200":
150
+ description: OK
151
+ headers:
152
+ Cache-Control:
153
+ description: Cache control directive for caching proxies
154
+ schema:
155
+ type: string
156
+ example: public, s-maxage=43200, stale-while-revalidate=3600
157
+ content:
158
+ application/json; charset=utf-8:
159
+ schema:
160
+ $ref: "#/components/schemas/MunicipalAuthority"
161
+ "401":
162
+ $ref: "#/components/responses/UnauthorizedError"
163
+ "403":
164
+ description: Forbidden
165
+ headers: {}
166
+ content:
167
+ application/json; charset=utf-8:
168
+ schema:
169
+ type: object
170
+ properties:
171
+ error_message:
172
+ type: string
173
+ error_status:
174
+ type: number
175
+ required:
176
+ - error_message
177
+ - error_status
178
+ examples:
179
+ response:
180
+ value:
181
+ error_message: Forbidden
182
+ error_status: 403
183
+ "404":
184
+ description: Not Found
185
+ headers: {}
186
+ content:
187
+ application/json; charset=utf-8:
188
+ schema:
189
+ type: object
190
+ properties:
191
+ error_message:
192
+ type: string
193
+ error_status:
194
+ type: number
195
+ required:
196
+ - error_message
197
+ - error_status
198
+ examples:
199
+ response:
200
+ value:
201
+ error_message: Not Found
202
+ error_status: 404
203
+
204
+ /v2/municipalauthorities/{id}/queues:
205
+ get:
206
+ summary: GET All Municipal Authority Waiting Queues
207
+ operationId: GETAllMunicipalAuthorityWaitingQueues
208
+ description: ""
209
+ tags:
210
+ - 🏛 Municipal Authorities (v2)
211
+ parameters:
212
+ - name: id
213
+ in: path
214
+ description: Identifier of the municipality.
215
+ required: true
216
+ example: skoduv-palac
217
+ schema:
218
+ type: string
219
+ responses:
220
+ "200":
221
+ description: OK
222
+ headers:
223
+ Cache-Control:
224
+ description: Cache control directive for caching proxies
225
+ schema:
226
+ type: string
227
+ example: public, s-maxage=43200, stale-while-revalidate=3600
228
+ content:
229
+ application/json; charset=utf-8:
230
+ schema:
231
+ $ref: "#/components/schemas/MunicipalAuthorityQueues"
232
+ "401":
233
+ $ref: "#/components/responses/UnauthorizedError"
234
+ "403":
235
+ description: Forbidden
236
+ headers: {}
237
+ content:
238
+ application/json; charset=utf-8:
239
+ schema:
240
+ type: object
241
+ properties:
242
+ error_message:
243
+ type: string
244
+ error_status:
245
+ type: number
246
+ required:
247
+ - error_message
248
+ - error_status
249
+ examples:
250
+ response:
251
+ value:
252
+ error_message: Forbidden
253
+ error_status: 403
254
+ "404":
255
+ description: Not Found
256
+ headers: {}
257
+ content:
258
+ application/json; charset=utf-8:
259
+ schema:
260
+ type: object
261
+ properties:
262
+ error_message:
263
+ type: string
264
+ error_status:
265
+ type: number
266
+ required:
267
+ - error_message
268
+ - error_status
269
+ examples:
270
+ response:
271
+ value:
272
+ error_message: Not Found
273
+ error_status: 404
274
+
275
+ components:
276
+ responses:
277
+ UnauthorizedError:
278
+ description: API key is missing or invalid
279
+ headers:
280
+ WWW_Authenticate:
281
+ schema:
282
+ type: string
283
+ schemas:
284
+ MunicipalAuthority:
285
+ type: object
286
+ properties:
287
+ geometry:
288
+ type: object
289
+ properties:
290
+ type:
291
+ type: string
292
+ example: Point
293
+ coordinates:
294
+ type: array
295
+ items:
296
+ type: number
297
+ example:
298
+ - 14.4633
299
+ - 50.07827
300
+ properties:
301
+ type: object
302
+ properties:
303
+ image:
304
+ type: object
305
+ properties:
306
+ mimetype:
307
+ type: string
308
+ example: image/png
309
+ size:
310
+ type: number
311
+ example: 714603
312
+ url:
313
+ type: string
314
+ example: https://www.mojepraha.eu/images/municipal-authorities/VJXPN4RVrTLnkih5.png
315
+ email:
316
+ type: array
317
+ items:
318
+ type: string
319
+ example: posta@praha.eu
320
+ telephone:
321
+ type: array
322
+ items:
323
+ type: string
324
+ example: "+420 777 7777"
325
+ web:
326
+ type: array
327
+ items:
328
+ type: string
329
+ example: "www.praha.eu/"
330
+ address:
331
+ type: object
332
+ properties:
333
+ address_formatted:
334
+ type: string
335
+ example: Dělnická 213/10, 17000 Praha-Holešovice, Česko
336
+ agendas:
337
+ type: array
338
+ items:
339
+ type: object
340
+ properties:
341
+ keywords:
342
+ type: array
343
+ items:
344
+ type: string
345
+ example: "nebytové prostory"
346
+ description:
347
+ type: string
348
+ example: Pronájem bytových a nebytových prostor
349
+ long_description:
350
+ type: string
351
+ example: Ověřování shody opisu nebo kopie s listinou a ověřování pravosti podpisu
352
+ district:
353
+ type: string
354
+ example: praha-15
355
+ id:
356
+ type: string
357
+ example: magistrat-hlavniho-mesta-prahy
358
+ name:
359
+ type: string
360
+ example: Magistrát hlavního města Prahy
361
+ official_board:
362
+ type: string
363
+ example: "http://www.praha.eu/jnp/cz/o_meste/magistrat/deska/index.html"
364
+ opening_hours:
365
+ type: array
366
+ items:
367
+ type: object
368
+ properties:
369
+ closes:
370
+ type: string
371
+ example: "12:00"
372
+ opens:
373
+ type: string
374
+ example: "08:00"
375
+ day_of_week:
376
+ type: string
377
+ example: Monday
378
+ description:
379
+ type: string
380
+ updated_at:
381
+ type: string
382
+ example: "2019-05-18T07:38:37.000Z"
383
+ type:
384
+ type: object
385
+ properties:
386
+ description:
387
+ type: string
388
+ example: Obecní úřad
389
+ id:
390
+ type: string
391
+ example: municipality
392
+ required:
393
+ - id
394
+ required:
395
+ - id
396
+ - name
397
+ type:
398
+ type: string
399
+ example: Feature
400
+ MunicipalAuthorityQueues:
401
+ type: object
402
+ properties:
403
+ last_updated:
404
+ type: string
405
+ example: 2019+04-30T09:56:00+02:00
406
+ municipal_authority_id:
407
+ type: string
408
+ example: skoduv-palac
409
+ served_activities:
410
+ type: array
411
+ items:
412
+ type: object
413
+ properties:
414
+ activity:
415
+ type: string
416
+ example: "OSV: CzechPoint"
417
+ number_of_person_in_queue:
418
+ type: number
419
+ example: 0
420
+ number_of_serving_counters:
421
+ type: number
422
+ example: 5
423
+ required:
424
+ - activity
425
+ - number_of_person_in_queue
426
+ - number_of_serving_counters
427
+ updated_at:
428
+ type: string
429
+ example: "2019-04-30T09:56:00+02:00"
430
+ title:
431
+ type: string
432
+ example: "Monitoring odbavování klientů ve Škodově paláci"
433
+ required:
434
+ - last_updated
435
+ - municipal_authority_id
436
+ - served_activities
437
+ - updated_at
438
+ - title
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@golemio/municipal-authorities",
3
- "version": "1.2.0",
3
+ "version": "1.2.2-rc.1450458255",
4
4
  "description": "Golemio Municipal Authorities Module",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",