-
Notifications
You must be signed in to change notification settings - Fork 4
/
test_openapi3.yml
377 lines (377 loc) · 9.04 KB
/
test_openapi3.yml
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
openapi: 3.0.0
info:
version: 1.0.0
title: openweathermap-swagger
description: A sample API
contact:
name: Swagger API Team
email: [email protected]
url: https://github.com/johndcarmichael/boats/
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
tags:
- name: weather
description: Weather data
paths:
/weather/:
get:
tags:
- weather
summary: Get weather
description: Query with varying content
operationId: weatherGet
parameters:
- $ref: '#/components/parameters/queryAppId'
- $ref: '#/components/parameters/queryCountry'
- $ref: '#/components/parameters/queryId'
- $ref: '#/components/parameters/queryLat'
- $ref: '#/components/parameters/queryLon'
- $ref: '#/components/parameters/headerSearchId'
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Weather'
'400':
description: Invalid Identifier supplied
'404':
description: Round not found
security:
- apiKeyAdmin: []
- jwtToken: []
- basic: []
x-passRequest: true
'/weather/{id}':
get:
tags:
- weather
summary: Get weather
description: Query with varying content
operationId: weatherIdGet
x-permission: getWeatherDetail
parameters:
- $ref: '#/components/parameters/pathId'
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/WeatherFull'
'400':
description: Invalid Identifier supplied
'404':
description: Round not found
security:
- apiKeyAdmin: []
- jwtToken: []
x-passThruWithoutJWT: true
/rain/:
get:
tags:
- weather
summary: Get weather
description: Query with varying content
operationId: rainGet
parameters:
- $ref: '#/components/parameters/queryCountry'
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Weather'
'400':
description: Invalid Identifier supplied
'404':
description: Round not found
post:
tags:
- weather
summary: Get weather
description: Query with varying content
operationId: rainPost
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Coord'
required: true
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Weather'
'400':
description: Invalid Identifier supplied
'404':
description: Round not found
x-passRequest: true
put:
tags:
- weather
summary: Get weather
description: Query with varying content
operationId: rainPut
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
image:
description: An image to upload
type: string
format: binary
required:
- image
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Weather'
'400':
description: Invalid Identifier supplied
'404':
description: Round not found
x-passRequest: true
/me/weather:
get:
tags:
- me
summary: Get my weather
operationId: getMyWeather
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Weather'
'404':
description: Round not found
security:
- apiToken: []
/weather-upload:
post:
tags:
- Wet-er
operationId: weatherUpload
summary: Upload new weather
description: Upload new weather (ie in case it's summer and you, a normal person, prefer winter)
requestBody:
required: true
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/WeatherUpload'
responses:
'201':
description: successful operation
servers:
- url: https://samples.openweathermap.org/data/2.5
- url: https://api.example.com
- url: https://api.example.com:8443/v1/reports
- url: https://localhost:3025/v1
- url: https://10.0.81.36/v1
- url: ws:https://api.example.com/v1
- url: wss:https://api.example.com/v1
- url: /v1/reports
- url: /
- url: //api.example.com
components:
parameters:
pathId:
in: path
name: id
required: true
schema:
type: string
queryAppId:
in: query
name: appid
required: true
description: |
Grab a free API key from here: https://openweathermap.org/price
schema:
type: string
queryCountry:
in: query
name: q
required: false
description: >
q city name and country code divided by comma, use ISO 3166 country
codes. for example: q=London,uk or just q=London
schema:
type: string
queryId:
in: query
name: id
required: false
description: >
City ID based on city.list.json.gz can be downloaded here
https://bulk.openweathermap.org/sample/
schema:
type: number
queryLat:
in: query
name: lat
required: false
description: |
Needs to be paired with lon
schema:
type: number
queryLon:
in: query
name: lon
required: false
description: |
Needs to be paired with lat
schema:
type: number
headerSearchId:
in: header
name: Search-Id
description: Unique search id
example: 569eecd9-9962-4aed-a0f0-30476c6a82ed
schema:
type: string
pattern: ^Bearer .+$
securitySchemes:
jwtToken:
type: apiKey
name: Authorization
in: header
apiKeyAdmin:
type: apiKey
name: x-api-key
in: header
apiToken:
type: http
scheme: bearer
basic:
type: http
scheme: basic
schemas:
AdditionalProps:
type: object
additionalProperties:
type: string
ArrayProps:
type: array
items:
type: string
Coord:
type: object
properties:
lon:
type: number
lat:
type: number
JwtAccess:
type: object
required:
- id
properties:
id:
type: string
WeatherFull:
allOf:
- $ref: '#/components/schemas/Weather'
- type: object
required:
- name
properties:
id:
type: string
name:
type: string
Weather:
type: object
required:
- coord
properties:
coord:
$ref: '#/components/schemas/Coord'
weather:
type: array
items:
type: object
properties:
id:
type: number
main:
type: string
description:
type: string
icon:
type: string
base:
type: string
main:
type: object
properties:
temp:
type: number
pressure:
type: number
humidity:
type: number
temp_min:
type: number
temp_max:
type: number
sea_level:
type: number
grnd_level:
type: number
wind:
type: object
properties:
speed:
type: number
deg:
type: number
clouds:
type: object
properties:
all:
type: number
dt:
type: number
sys:
type: object
properties:
message:
type: number
country:
type: string
sunrise:
type: number
sunset:
type: number
id:
type: number
name:
type: string
cod:
type: number
WeatherUpload:
type: object
properties:
rain:
type: boolean
pdfAboutHowMuchBetterWinterIs:
type: string
format: binary
startDate:
type: string
format: date