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
|
"""OpenAPI core validation response validators module"""
import warnings
from typing import Any
from typing import Dict
from typing import Iterator
from typing import List
from typing import Mapping
from typing import Optional
from jsonschema_path import SchemaPath
from openapi_spec_validator import OpenAPIV30SpecValidator
from openapi_spec_validator import OpenAPIV31SpecValidator
from openapi_core.casting.schemas import oas30_read_schema_casters_factory
from openapi_core.casting.schemas import oas31_schema_casters_factory
from openapi_core.exceptions import OpenAPIError
from openapi_core.protocols import HeadersType
from openapi_core.protocols import Request
from openapi_core.protocols import Response
from openapi_core.protocols import WebhookRequest
from openapi_core.templating.paths.exceptions import PathError
from openapi_core.templating.responses.exceptions import ResponseFinderError
from openapi_core.validation.decorators import ValidationErrorWrapper
from openapi_core.validation.exceptions import ValidationError
from openapi_core.validation.response.exceptions import DataValidationError
from openapi_core.validation.response.exceptions import HeadersError
from openapi_core.validation.response.exceptions import HeaderValidationError
from openapi_core.validation.response.exceptions import InvalidData
from openapi_core.validation.response.exceptions import InvalidHeader
from openapi_core.validation.response.exceptions import MissingData
from openapi_core.validation.response.exceptions import MissingHeader
from openapi_core.validation.response.exceptions import MissingRequiredHeader
from openapi_core.validation.schemas import (
oas30_read_schema_validators_factory,
)
from openapi_core.validation.schemas import oas31_schema_validators_factory
from openapi_core.validation.validators import BaseAPICallValidator
from openapi_core.validation.validators import BaseValidator
from openapi_core.validation.validators import BaseWebhookValidator
class BaseResponseValidator(BaseValidator):
def _iter_errors(
self,
status_code: int,
data: Optional[bytes],
headers: HeadersType,
mimetype: str,
operation: SchemaPath,
) -> Iterator[Exception]:
try:
operation_response = self._find_operation_response(
status_code, operation
)
# don't process if operation errors
except ResponseFinderError as exc:
yield exc
return
try:
self._get_data(data, mimetype, operation_response)
except DataValidationError as exc:
yield exc
try:
self._get_headers(headers, operation_response)
except HeadersError as exc:
yield from exc.context
def _iter_data_errors(
self,
status_code: int,
data: Optional[bytes],
mimetype: str,
operation: SchemaPath,
) -> Iterator[Exception]:
try:
operation_response = self._find_operation_response(
status_code, operation
)
# don't process if operation errors
except ResponseFinderError as exc:
yield exc
return
try:
self._get_data(data, mimetype, operation_response)
except DataValidationError as exc:
yield exc
def _iter_headers_errors(
self,
status_code: int,
headers: HeadersType,
operation: SchemaPath,
) -> Iterator[Exception]:
try:
operation_response = self._find_operation_response(
status_code, operation
)
# don't process if operation errors
except ResponseFinderError as exc:
yield exc
return
try:
self._get_headers(headers, operation_response)
except HeadersError as exc:
yield from exc.context
def _find_operation_response(
self,
status_code: int,
operation: SchemaPath,
) -> SchemaPath:
from openapi_core.templating.responses.finders import ResponseFinder
finder = ResponseFinder(operation / "responses")
return finder.find(str(status_code))
@ValidationErrorWrapper(DataValidationError, InvalidData)
def _get_data(
self,
data: Optional[bytes],
mimetype: str,
operation_response: SchemaPath,
) -> Any:
if "content" not in operation_response:
return None
content = operation_response / "content"
raw_data = self._get_data_value(data)
value, _ = self._get_content_and_schema(raw_data, content, mimetype)
return value
def _get_data_value(self, data: Optional[bytes]) -> bytes:
if not data:
raise MissingData
return data
def _get_headers(
self, headers: HeadersType, operation_response: SchemaPath
) -> Dict[str, Any]:
if "headers" not in operation_response:
return {}
response_headers = operation_response / "headers"
errors: List[OpenAPIError] = []
validated: Dict[str, Any] = {}
for name, header in list(response_headers.items()):
# ignore Content-Type header
if name.lower() == "content-type":
continue
try:
value = self._get_header(headers, name, header)
except MissingHeader:
continue
except ValidationError as exc:
errors.append(exc)
continue
else:
validated[name] = value
if errors:
raise HeadersError(context=iter(errors), headers=validated)
return validated
@ValidationErrorWrapper(HeaderValidationError, InvalidHeader, name="name")
def _get_header(
self, headers: Mapping[str, Any], name: str, header: SchemaPath
) -> Any:
deprecated = header.getkey("deprecated", False)
if deprecated:
warnings.warn(
f"{name} header is deprecated",
DeprecationWarning,
)
try:
value, _ = self._get_param_or_header_and_schema(
header, headers, name=name
)
except KeyError:
required = header.getkey("required", False)
if required:
raise MissingRequiredHeader(name)
raise MissingHeader(name)
else:
return value
class BaseAPICallResponseValidator(
BaseResponseValidator, BaseAPICallValidator
):
def iter_errors(
self,
request: Request,
response: Response,
) -> Iterator[Exception]:
raise NotImplementedError
def validate(
self,
request: Request,
response: Response,
) -> None:
for err in self.iter_errors(request, response):
raise err
class BaseWebhookResponseValidator(
BaseResponseValidator, BaseWebhookValidator
):
def iter_errors(
self,
request: WebhookRequest,
response: Response,
) -> Iterator[Exception]:
raise NotImplementedError
def validate(
self,
request: WebhookRequest,
response: Response,
) -> None:
for err in self.iter_errors(request, response):
raise err
class APICallResponseDataValidator(BaseAPICallResponseValidator):
def iter_errors(
self,
request: Request,
response: Response,
) -> Iterator[Exception]:
try:
_, operation, _, _, _ = self._find_path(request)
# don't process if operation errors
except PathError as exc:
yield exc
return
yield from self._iter_data_errors(
response.status_code,
response.data,
response.content_type,
operation,
)
class APICallResponseHeadersValidator(BaseAPICallResponseValidator):
def iter_errors(
self,
request: Request,
response: Response,
) -> Iterator[Exception]:
try:
_, operation, _, _, _ = self._find_path(request)
# don't process if operation errors
except PathError as exc:
yield exc
return
yield from self._iter_headers_errors(
response.status_code, response.headers, operation
)
class APICallResponseValidator(BaseAPICallResponseValidator):
def iter_errors(
self,
request: Request,
response: Response,
) -> Iterator[Exception]:
try:
_, operation, _, _, _ = self._find_path(request)
# don't process if operation errors
except PathError as exc:
yield exc
return
yield from self._iter_errors(
response.status_code,
response.data,
response.headers,
response.content_type,
operation,
)
class WebhookResponseDataValidator(BaseWebhookResponseValidator):
def iter_errors(
self,
request: WebhookRequest,
response: Response,
) -> Iterator[Exception]:
try:
_, operation, _, _, _ = self._find_path(request)
# don't process if operation errors
except PathError as exc:
yield exc
return
yield from self._iter_data_errors(
response.status_code,
response.data,
response.content_type,
operation,
)
class WebhookResponseHeadersValidator(BaseWebhookResponseValidator):
def iter_errors(
self,
request: WebhookRequest,
response: Response,
) -> Iterator[Exception]:
try:
_, operation, _, _, _ = self._find_path(request)
# don't process if operation errors
except PathError as exc:
yield exc
return
yield from self._iter_headers_errors(
response.status_code, response.headers, operation
)
class WebhookResponseValidator(BaseWebhookResponseValidator):
def iter_errors(
self,
request: WebhookRequest,
response: Response,
) -> Iterator[Exception]:
try:
_, operation, _, _, _ = self._find_path(request)
# don't process if operation errors
except PathError as exc:
yield exc
return
yield from self._iter_errors(
response.status_code,
response.data,
response.headers,
response.content_type,
operation,
)
class V30ResponseDataValidator(APICallResponseDataValidator):
spec_validator_cls = OpenAPIV30SpecValidator
schema_casters_factory = oas30_read_schema_casters_factory
schema_validators_factory = oas30_read_schema_validators_factory
class V30ResponseHeadersValidator(APICallResponseHeadersValidator):
spec_validator_cls = OpenAPIV30SpecValidator
schema_casters_factory = oas30_read_schema_casters_factory
schema_validators_factory = oas30_read_schema_validators_factory
class V30ResponseValidator(APICallResponseValidator):
spec_validator_cls = OpenAPIV30SpecValidator
schema_casters_factory = oas30_read_schema_casters_factory
schema_validators_factory = oas30_read_schema_validators_factory
class V31ResponseDataValidator(APICallResponseDataValidator):
spec_validator_cls = OpenAPIV31SpecValidator
schema_casters_factory = oas31_schema_casters_factory
schema_validators_factory = oas31_schema_validators_factory
class V31ResponseHeadersValidator(APICallResponseHeadersValidator):
spec_validator_cls = OpenAPIV31SpecValidator
schema_casters_factory = oas31_schema_casters_factory
schema_validators_factory = oas31_schema_validators_factory
class V31ResponseValidator(APICallResponseValidator):
spec_validator_cls = OpenAPIV31SpecValidator
schema_casters_factory = oas31_schema_casters_factory
schema_validators_factory = oas31_schema_validators_factory
class V31WebhookResponseDataValidator(WebhookResponseDataValidator):
spec_validator_cls = OpenAPIV31SpecValidator
schema_casters_factory = oas31_schema_casters_factory
schema_validators_factory = oas31_schema_validators_factory
class V31WebhookResponseHeadersValidator(WebhookResponseHeadersValidator):
spec_validator_cls = OpenAPIV31SpecValidator
schema_casters_factory = oas31_schema_casters_factory
schema_validators_factory = oas31_schema_validators_factory
class V31WebhookResponseValidator(WebhookResponseValidator):
spec_validator_cls = OpenAPIV31SpecValidator
schema_casters_factory = oas31_schema_casters_factory
schema_validators_factory = oas31_schema_validators_factory
|
