-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.json
470 lines (470 loc) · 14.6 KB
/
openapi.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
{
"openapi": "3.0.2",
"info": {
"title": "OpenWeatherMap API",
"description": "Get the current weather, daily forecast for 16 days, and a three-hour-interval forecast for 5 days for your city. Helpful stats, graphics, and this day in history charts are available for your reference. Interactive maps show precipitation, clouds, pressure, wind around your location stations. Data is available in JSON, XML, or HTML format. **Note**: This sample Swagger file covers the `current` endpoint only from the OpenWeatherMap API. <br/><br/> **Note**: All parameters are optional, but you must select at least one parameter. Calling the API by city ID (using the `id` parameter) will provide the most precise location results.",
"version": "2.5",
"termsOfService": "https://openweathermap.org/terms",
"contact": {
"name": "OpenWeatherMap API",
"url": "https://openweathermap.org/api",
"email": "[email protected]"
},
"license": {
"name": "CC Attribution-ShareAlike 4.0 (CC BY-SA 4.0)",
"url": "https://openweathermap.org/price"
}
},
"servers": [
{
"url": "https://api.openweathermap.org/data/2.5"
}
],
"paths": {
"/weather": {
"get": {
"tags": [
"Current Weather Data"
],
"summary": "Call current weather data for one location",
"description": "Access current weather data for any location on Earth including over 200,000 cities! Current weather is frequently updated based on global models and data from more than 40,000 weather stations.",
"operationId": "CurrentWeatherData",
"parameters": [
{
"$ref": "#/components/parameters/q"
},
{
"$ref": "#/components/parameters/id"
},
{
"$ref": "#/components/parameters/lat"
},
{
"$ref": "#/components/parameters/lon"
},
{
"$ref": "#/components/parameters/zip"
},
{
"$ref": "#/components/parameters/units"
},
{
"$ref": "#/components/parameters/lang"
},
{
"$ref": "#/components/parameters/mode"
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/200"
}
}
}
},
"404": {
"description": "Not found response",
"content": {
"text/plain": {
"schema": {
"title": "Weather not found",
"type": "string",
"example": "Not found"
}
}
}
}
}
}
}
},
"security": [
{
"app_id": []
}
],
"tags": [
{
"name": "Current Weather Data",
"description": "Get current weather details"
}
],
"externalDocs": {
"description": "API Documentation",
"url": "http://openweathermap.org/api"
},
"components": {
"parameters": {
"q": {
"name": "q",
"in": "query",
"description": "**City name**. *Example: London*. You can call by city name, or by city name and country code. The API responds with a list of results that match a searching word. For the query value, type the city name and optionally the country code divided by a comma; use ISO 3166 country codes.",
"schema": {
"type": "string"
}
},
"id": {
"name": "id",
"in": "query",
"description": "**City ID**. *Example: `2172797`*. You can call by city ID. The API responds with the exact result. The List of city IDs can be downloaded [here](http://bulk.openweathermap.org/sample/). You can include multiple cities in this parameter — just separate them by commas. The limit of locations is 20. *Note: A single ID counts as a one API call. So, if you have city IDs, it's treated as 3 API calls.*",
"schema": {
"type": "string"
}
},
"lat": {
"name": "lat",
"in": "query",
"description": "**Latitude**. *Example: 35*. The latitude coordinate of the location of your interest. Must use with `lon`.",
"schema": {
"type": "string"
}
},
"lon": {
"name": "lon",
"in": "query",
"description": "**Longitude**. *Example: 139*. Longitude coordinate of the location of your interest. Must use with `lat`.",
"schema": {
"type": "string"
}
},
"zip": {
"name": "zip",
"in": "query",
"description": "**Zip code**. Search by zip code. *Example: 95050,us*. Please note that if the country is not specified, the search uses USA as a default.",
"schema": {
"type": "string"
}
},
"units": {
"name": "units",
"in": "query",
"description": "**Units**. *Example: imperial*. Possible values: `standard`, `metric`, and `imperial`. When you do not use the `units` parameter, the format is `standard` by default.",
"schema": {
"type": "string",
"enum": [
"standard",
"metric",
"imperial"
],
"default": "imperial"
}
},
"lang": {
"name": "lang",
"in": "query",
"description": "**Language**. *Example: en*. You can use lang parameter to get the output in your language. We support the following languages that you can use with the corresponded lang values: Arabic - `ar`, Bulgarian - `bg`, Catalan - `ca`, Czech - `cz`, German - `de`, Greek - `el`, English - `en`, Persian (Farsi) - `fa`, Finnish - `fi`, French - `fr`, Galician - `gl`, Croatian - `hr`, Hungarian - `hu`, Italian - `it`, Japanese - `ja`, Korean - `kr`, Latvian - `la`, Lithuanian - `lt`, Macedonian - `mk`, Dutch - `nl`, Polish - `pl`, Portuguese - `pt`, Romanian - `ro`, Russian - `ru`, Swedish - `se`, Slovak - `sk`, Slovenian - `sl`, Spanish - `es`, Turkish - `tr`, Ukrainian - `ua`, Vietnamese - `vi`, Chinese Simplified - `zh_cn`, Chinese Traditional - `zh_tw`.",
"schema": {
"type": "string",
"enum": [
"ar",
"bg",
"ca",
"cz",
"de",
"el",
"en",
"fa",
"fi",
"fr",
"gl",
"hr",
"hu",
"it",
"ja",
"kr",
"la",
"lt",
"mk",
"nl",
"pl",
"pt",
"ro",
"ru",
"se",
"sk",
"sl",
"es",
"tr",
"ua",
"vi",
"zh_cn",
"zh_tw"
],
"default": "en"
}
},
"mode": {
"name": "mode",
"in": "query",
"description": "**Mode**. *Example: html*. Determines the format of the response. Possible values are `xml` and `html`. If the mode parameter is empty, the format is `json` by default.",
"schema": {
"type": "string",
"enum": [
"json",
"xml",
"html"
],
"default": "json"
}
}
},
"schemas": {
"200": {
"title": "Successful response",
"type": "object",
"properties": {
"coord": {
"$ref": "#/components/schemas/Coord"
},
"weather": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Weather"
},
"description": "(more info Weather condition codes)"
},
"base": {
"type": "string",
"description": "Internal parameter",
"example": "cmc stations"
},
"main": {
"$ref": "#/components/schemas/Main"
},
"visibility": {
"type": "integer",
"description": "Visibility, meter",
"example": 16093
},
"wind": {
"$ref": "#/components/schemas/Wind"
},
"clouds": {
"$ref": "#/components/schemas/Clouds"
},
"rain": {
"$ref": "#/components/schemas/Rain"
},
"snow": {
"$ref": "#/components/schemas/Snow"
},
"dt": {
"type": "integer",
"description": "Time of data calculation, unix, UTC",
"format": "int32",
"example": 1435658272
},
"sys": {
"$ref": "#/components/schemas/Sys"
},
"id": {
"type": "integer",
"description": "City ID",
"format": "int32",
"example": 2172797
},
"name": {
"type": "string",
"example": "Cairns"
},
"cod": {
"type": "integer",
"description": "Internal parameter",
"format": "int32",
"example": 200
}
}
},
"Coord": {
"title": "Coord",
"type": "object",
"properties": {
"lon": {
"type": "number",
"description": "City geo location, longitude",
"example": 145.77
},
"lat": {
"type": "number",
"description": "City geo location, latitude",
"example": -16.92
}
}
},
"Weather": {
"title": "Weather",
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Weather condition id",
"format": "int32",
"example": 803
},
"main": {
"type": "string",
"description": "Group of weather parameters (Rain, Snow, Extreme etc.)",
"example": "Clouds"
},
"description": {
"type": "string",
"description": "Weather condition within the group",
"example": "broken clouds"
},
"icon": {
"type": "string",
"description": "Weather icon id",
"example": "04n"
}
}
},
"Main": {
"title": "Main",
"type": "object",
"properties": {
"temp": {
"type": "number",
"description": "Temperature. Unit Default: Kelvin, Metric: Celsius, Imperial: Fahrenheit.",
"example": 293.25
},
"pressure": {
"type": "integer",
"description": "Atmospheric pressure (on the sea level, if there is no sea_level or grnd_level data), hPa",
"format": "int32",
"example": 1019
},
"humidity": {
"type": "integer",
"description": "Humidity, %",
"format": "int32",
"example": 83
},
"temp_min": {
"type": "number",
"description": "Minimum temperature at the moment. This is deviation from current temp that is possible for large cities and megalopolises geographically expanded (use these parameter optionally). Unit Default: Kelvin, Metric: Celsius, Imperial: Fahrenheit.",
"example": 289.82
},
"temp_max": {
"type": "number",
"description": "Maximum temperature at the moment. This is deviation from current temp that is possible for large cities and megalopolises geographically expanded (use these parameter optionally). Unit Default: Kelvin, Metric: Celsius, Imperial: Fahrenheit.",
"example": 295.37
},
"sea_level": {
"type": "number",
"description": "Atmospheric pressure on the sea level, hPa",
"example": 984
},
"grnd_level": {
"type": "number",
"description": "Atmospheric pressure on the ground level, hPa",
"example": 990
}
}
},
"Wind": {
"title": "Wind",
"type": "object",
"properties": {
"speed": {
"type": "number",
"description": "Wind speed. Unit Default: meter/sec, Metric: meter/sec, Imperial: miles/hour.",
"example": 5.1
},
"deg": {
"type": "integer",
"description": "Wind direction, degrees (meteorological)",
"format": "int32",
"example": 150
}
}
},
"Clouds": {
"title": "Clouds",
"type": "object",
"properties": {
"all": {
"type": "integer",
"description": "Cloudiness, %",
"format": "int32",
"example": 75
}
}
},
"Rain": {
"title": "Rain",
"type": "object",
"properties": {
"3h": {
"type": "integer",
"description": "Rain volume for the last 3 hours",
"format": "int32",
"example": 3
}
}
},
"Snow": {
"title": "Snow",
"type": "object",
"properties": {
"3h": {
"type": "number",
"description": "Snow volume for the last 3 hours",
"example": 6
}
}
},
"Sys": {
"title": "Sys",
"type": "object",
"properties": {
"type": {
"type": "integer",
"description": "Internal parameter",
"format": "int32",
"example": 1
},
"id": {
"type": "integer",
"description": "Internal parameter",
"format": "int32",
"example": 8166
},
"message": {
"type": "number",
"description": "Internal parameter",
"example": 0.0166
},
"country": {
"type": "string",
"description": "Country code (GB, JP etc.)",
"example": "AU"
},
"sunrise": {
"type": "integer",
"description": "Sunrise time, unix, UTC",
"format": "int32",
"example": 1435610796
},
"sunset": {
"type": "integer",
"description": "Sunset time, unix, UTC",
"format": "int32",
"example": 1435650870
}
}
}
},
"securitySchemes": {
"app_id": {
"type": "apiKey",
"description": "API key to authorize requests.",
"name": "appid",
"in": "query"
}
}
}
}