@golemio/air-quality-stations 1.0.5-dev.568804852 → 1.0.6-dev.585620186

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/.gitkeep +0 -0
  2. package/docs/openapi.yaml +293 -0
  3. package/package.json +1 -1
package/docs/.gitkeep ADDED
File without changes
package/docs/openapi.yaml ADDED
@@ -0,0 +1,293 @@
1
+ openapi: 3.0.1
2
+ info:
3
+ title: Air Quality 🌦
4
+ version: 1.0.0
5
+ tags:
6
+ - name: Air Quality 🌦
7
+ paths:
8
+ /airqualitystations/:
9
+ get:
10
+ tags:
11
+ - Air Quality 🌦
12
+ summary: GET All Air Quality CHMI Stations
13
+ parameters:
14
+ - name: latlng
15
+ in: query
16
+ description: Sorting by location (Latitude and Longitude separated by comma,
17
+ latitude first).
18
+ schema:
19
+ type: string
20
+ example: 50.124935,14.457204
21
+ - name: range
22
+ in: query
23
+ description: Filter by distance from latlng in meters (range query). Depends
24
+ on the latlng parameter.
25
+ schema:
26
+ type: number
27
+ example: 5000
28
+ - name: districts
29
+ in: query
30
+ description: Filter by Prague city districts (slug) separated by comma.
31
+ style: form
32
+ explode: false
33
+ schema:
34
+ type: array
35
+ items:
36
+ type: string
37
+ example: praha-4
38
+ - name: limit
39
+ in: query
40
+ description: Limits number of retrieved items. The maximum is 10000 (default
41
+ value).
42
+ schema:
43
+ type: number
44
+ example: 10
45
+ - name: offset
46
+ in: query
47
+ description: Number of the first items that are skipped.
48
+ schema:
49
+ type: number
50
+ example: 0
51
+ - name: updatedSince
52
+ in: query
53
+ description: Filters all results with older updated_at than this parameter
54
+ schema:
55
+ type: string
56
+ example: "2019-05-18T07:38:37.000Z"
57
+ - name: x-access-token
58
+ in: header
59
+ description: e.g. YOUR_ACCESS_TOKEN
60
+ schema:
61
+ type: string
62
+ example: YOUR_ACCESS_TOKEN
63
+ responses:
64
+ 200:
65
+ description: OK
66
+ content:
67
+ application/json; charset=utf-8:
68
+ schema:
69
+ required:
70
+ - type
71
+ type: object
72
+ properties:
73
+ type:
74
+ type: string
75
+ features:
76
+ type: array
77
+ items:
78
+ $ref: '#/components/schemas/FeaturePoint'
79
+ example:
80
+ type: FeatureCollection
81
+ features:
82
+ - geometry:
83
+ type: Point
84
+ coordinates:
85
+ - 14.4633
86
+ - 50.07827
87
+ properties:
88
+ id: ACHOA
89
+ district: praha-11
90
+ measurement:
91
+ AQ_hourly_index: 3
92
+ components:
93
+ - averaged_time:
94
+ averaged_hours: 1
95
+ value: 10.7
96
+ type: NO2
97
+ name: Praha 4-Chodov
98
+ updated_at: "2019-05-18T07:38:37.000Z"
99
+ type: Feature
100
+ 403:
101
+ description: Forbidden
102
+ content:
103
+ application/json; charset=utf-8:
104
+ schema:
105
+ $ref: '#/components/schemas/Error'
106
+ example:
107
+ error_message: Forbidden
108
+ error_status: 403
109
+ /airqualitystations/history/:
110
+ get:
111
+ tags:
112
+ - Air Quality 🌦
113
+ summary: GET Air Quality Stations CHMI History
114
+ parameters:
115
+ - name: limit
116
+ in: query
117
+ description: Limits number of retrieved items. The maximum is 10000 (default
118
+ value).
119
+ schema:
120
+ type: number
121
+ example: 10
122
+ - name: offset
123
+ in: query
124
+ description: Number of the first items that are skipped.
125
+ schema:
126
+ type: number
127
+ example: 0
128
+ - name: from
129
+ in: query
130
+ description: Date in ISO8601, limits data measured from this datetime
131
+ schema:
132
+ type: string
133
+ example: "2019-05-16T04:27:58.000Z"
134
+ - name: to
135
+ in: query
136
+ description: Date in ISO8601, limits data measured up until this datetime
137
+ schema:
138
+ type: string
139
+ example: "2019-05-18T04:27:58.000Z"
140
+ - name: sensorId
141
+ in: query
142
+ description: Limits data measured up by sensor with this id
143
+ schema:
144
+ type: string
145
+ example: 12345
146
+ - name: x-access-token
147
+ in: header
148
+ description: e.g. YOUR_ACCESS_TOKEN
149
+ schema:
150
+ type: string
151
+ example: YOUR_ACCESS_TOKEN
152
+ responses:
153
+ 200:
154
+ description: OK
155
+ content:
156
+ application/json; charset=utf-8:
157
+ schema:
158
+ type: array
159
+ items:
160
+ $ref: '#/components/schemas/AirQualityStationHistory'
161
+ example:
162
+ - id: ACHOA
163
+ measurement:
164
+ AQ_hourly_index: 3
165
+ components:
166
+ - averaged_time:
167
+ averaged_hours: 1
168
+ value: 10.7
169
+ type: NO2
170
+ updated_at: "2019-05-18T07:38:37.000Z"
171
+ 403:
172
+ description: Forbidden
173
+ content:
174
+ application/json; charset=utf-8:
175
+ schema:
176
+ $ref: '#/components/schemas/Error'
177
+ example:
178
+ error_message: Forbidden
179
+ error_status: 403
180
+ components:
181
+ schemas:
182
+ Point:
183
+ title: Point
184
+ type: array
185
+ minItems: 2
186
+ maxItems: 2
187
+ items:
188
+ type: number
189
+ example:
190
+ - 14.4633
191
+ - 50.07827
192
+ Error:
193
+ title: Error
194
+ required:
195
+ - error_message
196
+ - error_status
197
+ type: object
198
+ properties:
199
+ error_message:
200
+ type: string
201
+ example: Not Found
202
+ error_status:
203
+ type: number
204
+ example: 404
205
+ FeaturePoint:
206
+ title: Feature Point
207
+ required:
208
+ - geometry
209
+ - properties
210
+ - type
211
+ type: object
212
+ properties:
213
+ geometry:
214
+ required:
215
+ - coordinates
216
+ - type
217
+ type: object
218
+ properties:
219
+ type:
220
+ type: string
221
+ coordinates:
222
+ $ref: '#/components/schemas/Point'
223
+ properties:
224
+ $ref: '#/components/schemas/AirQualityStation'
225
+ type:
226
+ type: string
227
+ AirQualityStation:
228
+ title: Air Quality Station
229
+ required:
230
+ - id
231
+ - name
232
+ type: object
233
+ properties:
234
+ id:
235
+ type: string
236
+ example: ACHOA
237
+ district:
238
+ type: string
239
+ example: praha-11
240
+ measurement:
241
+ type: object
242
+ properties:
243
+ AQ_hourly_index:
244
+ type: number
245
+ example: 3
246
+ components:
247
+ type: array
248
+ items:
249
+ $ref: '#/components/schemas/AirQualityStationComponent'
250
+ name:
251
+ type: string
252
+ example: Praha 4-Chodov
253
+ updated_at:
254
+ type: string
255
+ example: "2019-05-18T07:38:37.000Z"
256
+ AirQualityStationComponent:
257
+ title: Air Quality Station Component
258
+ type: object
259
+ properties:
260
+ averaged_time:
261
+ type: object
262
+ properties:
263
+ averaged_hours:
264
+ type: number
265
+ example: 1
266
+ value:
267
+ type: number
268
+ example: 10.7
269
+ type:
270
+ type: string
271
+ example: NO2
272
+ AirQualityStationHistory:
273
+ title: Air Quality Station History
274
+ required:
275
+ - id
276
+ type: object
277
+ properties:
278
+ id:
279
+ type: string
280
+ example: ACHOA
281
+ measurement:
282
+ type: object
283
+ properties:
284
+ AQ_hourly_index:
285
+ type: number
286
+ example: 3
287
+ components:
288
+ type: array
289
+ items:
290
+ $ref: '#/components/schemas/AirQualityStationComponent'
291
+ updated_at:
292
+ type: string
293
+ example: "2019-05-18T07:38:37.000Z"
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@golemio/air-quality-stations",
3
- "version": "1.0.5-dev.568804852",
3
+ "version": "1.0.6-dev.585620186",
4
4
  "description": "Golemio Air Quality Stations Module",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",