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
|
""".convert_operation() test suite."""
import pytest
import sphinxcontrib.openapi._lib2to3 as lib2to3
@pytest.fixture(scope="function")
def convert_operation(oas_fragment):
def _wrapper(operation):
oas2 = oas_fragment(
"""
swagger: "2.0"
info:
title: An example spec
version: "1.0"
paths:
/test:
get:
responses:
'200':
description: a response description
"""
)
oas2["paths"]["/test"]["get"] = operation
oas3 = lib2to3.convert(oas2)
return oas3["paths"]["/test"]["get"]
return _wrapper
def test_minimal(convert_operation, oas_fragment):
converted = convert_operation(
oas_fragment(
"""
responses:
'200':
description: a response description
"""
),
)
assert converted == oas_fragment(
"""
responses:
'200':
description: a response description
"""
)
def test_complete(convert_operation, oas_fragment):
converted = convert_operation(
oas_fragment(
"""
tags:
- tag_a
- tag_b
summary: an operation summary
description: an operation description
externalDocs: https://docs.example.com/
operationId: myOperation
produces:
- application/json
parameters:
- in: header
name: token
type: string
- in: path
name: username
required: true
type: string
- in: query
name: id
type: string
deprecated: false
responses:
'200':
description: a response description
schema:
items:
format: int32
type: integer
type: array
"""
),
)
assert converted == oas_fragment(
"""
tags:
- tag_a
- tag_b
summary: an operation summary
description: an operation description
externalDocs: https://docs.example.com/
operationId: myOperation
parameters:
- in: header
name: token
schema:
type: string
- in: path
name: username
required: true
schema:
type: string
- in: query
name: id
schema:
type: string
deprecated: false
responses:
'200':
content:
application/json:
schema:
items:
format: int32
type: integer
type: array
description: a response description
"""
)
def test_request_body(convert_operation, oas_fragment):
converted = convert_operation(
oas_fragment(
"""
description: an operation description
consumes:
- application/json
parameters:
- in: path
name: username
required: true
type: string
- in: body
name: inventory
schema:
type: object
properties:
t-shirt:
type: boolean
required: true
responses:
'200':
description: a response description
"""
),
)
assert converted == oas_fragment(
"""
description: an operation description
parameters:
- in: path
name: username
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
t-shirt:
type: boolean
required: true
responses:
'200':
description: a response description
"""
)
def test_request_body_formdata(convert_operation, oas_fragment):
converted = convert_operation(
oas_fragment(
"""
description: an operation description
consumes:
- application/x-www-form-urlencoded
parameters:
- in: path
name: username
required: true
type: string
- in: formData
name: t-shirt
type: boolean
responses:
'200':
description: a response description
"""
),
)
assert converted == oas_fragment(
"""
description: an operation description
parameters:
- in: path
name: username
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
t-shirt:
type: boolean
responses:
'200':
description: a response description
"""
)
def test_only_request_body(convert_operation, oas_fragment):
converted = convert_operation(
oas_fragment(
"""
description: an operation description
consumes:
- application/json
parameters:
- in: body
name: inventory
schema:
type: object
properties:
t-shirt:
type: boolean
required: true
responses:
'200':
description: a response description
"""
),
)
assert converted == oas_fragment(
"""
description: an operation description
requestBody:
content:
application/json:
schema:
type: object
properties:
t-shirt:
type: boolean
required: true
responses:
'200':
description: a response description
"""
)
def test_vendor_extensions(convert_operation, oas_fragment):
converted = convert_operation(
oas_fragment(
"""
responses:
'200':
description: a response description
x-vendor-ext: vendor-ext
"""
),
)
assert converted == oas_fragment(
"""
responses:
'200':
description: a response description
x-vendor-ext: vendor-ext
"""
)
|
