Auto-detect request and response validator proxies

Author: p1c2u

openapi_core/unmarshalling/schemas/__init__.py

@@ -1,4 +1,5 @@
 from openapi_schema_validator import OAS30Validator
+from openapi_schema_validator import OAS31Validator
 
 from openapi_core.unmarshalling.schemas.enums import UnmarshalContext
 from openapi_core.unmarshalling.schemas.factories import (
@@ -8,6 +9,9 @@
 __all__ = [
     "oas30_request_schema_unmarshallers_factory",
     "oas30_response_schema_unmarshallers_factory",
+    "oas31_request_schema_unmarshallers_factory",
+    "oas31_response_schema_unmarshallers_factory",
+    "oas31_schema_unmarshallers_factory",
 ]
 
 oas30_request_schema_unmarshallers_factory = SchemaUnmarshallersFactory(
@@ -19,3 +23,13 @@
     OAS30Validator,
     context=UnmarshalContext.RESPONSE,
 )
+
+oas31_schema_unmarshallers_factory = SchemaUnmarshallersFactory(
+    OAS31Validator,
+)
+
+# alias to v31 version (request/response are the same bcs no context needed)
+oas31_request_schema_unmarshallers_factory = oas31_schema_unmarshallers_factory
+oas31_response_schema_unmarshallers_factory = (
+    oas31_schema_unmarshallers_factory
+)

openapi_core/validation/exceptions.py

@@ -4,6 +4,10 @@
 from openapi_core.exceptions import OpenAPIError
 
 
+class ValidatorDetectError(OpenAPIError):
+    pass
+
+
 class ValidationError(OpenAPIError):
     pass
 

openapi_core/validation/request/__init__.py

@@ -2,6 +2,10 @@
 from openapi_core.unmarshalling.schemas import (
     oas30_request_schema_unmarshallers_factory,
 )
+from openapi_core.unmarshalling.schemas import (
+    oas31_schema_unmarshallers_factory,
+)
+from openapi_core.validation.request.proxies import DetectRequestValidatorProxy
 from openapi_core.validation.request.validators import RequestBodyValidator
 from openapi_core.validation.request.validators import (
     RequestParametersValidator,
@@ -14,10 +18,15 @@
     "openapi_v30_request_parameters_validator",
     "openapi_v30_request_security_validator",
     "openapi_v30_request_validator",
+    "openapi_v31_request_body_validator",
+    "openapi_v31_request_parameters_validator",
+    "openapi_v31_request_security_validator",
+    "openapi_v31_request_validator",
     "openapi_request_body_validator",
     "openapi_request_parameters_validator",
     "openapi_request_security_validator",
     "openapi_request_validator",
+    "openapi_request_validator_proxy",
 ]
 
 openapi_v30_request_body_validator = RequestBodyValidator(
@@ -33,8 +42,29 @@
     schema_unmarshallers_factory=oas30_request_schema_unmarshallers_factory,
 )
 
+openapi_v31_request_body_validator = RequestBodyValidator(
+    schema_unmarshallers_factory=oas31_schema_unmarshallers_factory,
+)
+openapi_v31_request_parameters_validator = RequestParametersValidator(
+    schema_unmarshallers_factory=oas31_schema_unmarshallers_factory,
+)
+openapi_v31_request_security_validator = RequestSecurityValidator(
+    schema_unmarshallers_factory=oas31_schema_unmarshallers_factory,
+)
+openapi_v31_request_validator = RequestValidator(
+    schema_unmarshallers_factory=oas31_schema_unmarshallers_factory,
+)
+
 # alias to the latest v3 version
-openapi_request_body_validator = openapi_v30_request_body_validator
-openapi_request_parameters_validator = openapi_v30_request_parameters_validator
-openapi_request_security_validator = openapi_v30_request_security_validator
-openapi_request_validator = openapi_v30_request_validator
+openapi_request_body_validator = openapi_v31_request_body_validator
+openapi_request_parameters_validator = openapi_v31_request_parameters_validator
+openapi_request_security_validator = openapi_v31_request_security_validator
+openapi_request_validator = openapi_v31_request_validator
+
+# detect version spec
+openapi_request_validator_proxy = DetectRequestValidatorProxy(
+    {
+        ("openapi", "3.0"): openapi_v30_request_validator,
+        ("openapi", "3.1"): openapi_v31_request_validator,
+    },
+)

openapi_core/validation/request/proxies.py

@@ -0,0 +1,55 @@
+"""OpenAPI spec validator validation proxies module."""
+from typing import Any
+from typing import Hashable
+from typing import Iterator
+from typing import Mapping
+from typing import Optional
+from typing import Tuple
+
+from openapi_core.exceptions import OpenAPIError
+from openapi_core.spec import Spec
+from openapi_core.validation.exceptions import ValidatorDetectError
+from openapi_core.validation.request.datatypes import RequestValidationResult
+from openapi_core.validation.request.protocols import Request
+from openapi_core.validation.request.validators import RequestValidator
+
+
+class DetectRequestValidatorProxy:
+    def __init__(self, choices: Mapping[Tuple[str, str], RequestValidator]):
+        self.choices = choices
+
+    def detect(self, spec: Spec) -> RequestValidator:
+        for (key, value), validator in self.choices.items():
+            if key in spec and spec[key].startswith(value):
+                return validator
+        raise ValidatorDetectError("Spec schema version not detected")
+
+    def validate(
+        self,
+        spec: Spec,
+        request: Request,
+        base_url: Optional[str] = None,
+    ) -> RequestValidationResult:
+        validator = self.detect(spec)
+        return validator.validate(spec, request, base_url=base_url)
+
+    def is_valid(
+        self,
+        spec: Spec,
+        request: Request,
+        base_url: Optional[str] = None,
+    ) -> bool:
+        validator = self.detect(spec)
+        error = next(
+            validator.iter_errors(spec, request, base_url=base_url), None
+        )
+        return error is None
+
+    def iter_errors(
+        self,
+        spec: Spec,
+        request: Request,
+        base_url: Optional[str] = None,
+    ) -> Iterator[OpenAPIError]:
+        validator = self.detect(spec)
+        yield from validator.iter_errors(spec, request, base_url=base_url)

openapi_core/validation/request/validators.py

@@ -2,6 +2,7 @@
 import warnings
 from typing import Any
 from typing import Dict
+from typing import Iterator
 from typing import Optional
 
 from openapi_core.casting.schemas import schema_casters_factory
@@ -20,6 +21,7 @@
 from openapi_core.deserializing.parameters.factories import (
     ParameterDeserializersFactory,
 )
+from openapi_core.exceptions import OpenAPIError
 from openapi_core.security import security_provider_factory
 from openapi_core.security.exceptions import SecurityError
 from openapi_core.security.factories import SecurityProviderFactory
@@ -64,6 +66,15 @@ def __init__(
         )
         self.security_provider_factory = security_provider_factory
 
+    def iter_errors(
+        self,
+        spec: Spec,
+        request: Request,
+        base_url: Optional[str] = None,
+    ) -> Iterator[OpenAPIError]:
+        result = self.validate(spec, request, base_url=base_url)
+        yield from result.errors
+
     def validate(
         self,
         spec: Spec,

openapi_core/validation/response/__init__.py

@@ -2,6 +2,12 @@
 from openapi_core.unmarshalling.schemas import (
     oas30_response_schema_unmarshallers_factory,
 )
+from openapi_core.unmarshalling.schemas import (
+    oas31_schema_unmarshallers_factory,
+)
+from openapi_core.validation.response.proxies import (
+    DetectResponseValidatorProxy,
+)
 from openapi_core.validation.response.validators import ResponseDataValidator
 from openapi_core.validation.response.validators import (
     ResponseHeadersValidator,
@@ -12,9 +18,13 @@
     "openapi_v30_response_data_validator",
     "openapi_v30_response_headers_validator",
     "openapi_v30_response_validator",
+    "openapi_v31_response_data_validator",
+    "openapi_v31_response_headers_validator",
+    "openapi_v31_response_validator",
     "openapi_response_data_validator",
     "openapi_response_headers_validator",
     "openapi_response_validator",
+    "openapi_response_validator_proxy",
 ]
 
 openapi_v30_response_data_validator = ResponseDataValidator(
@@ -27,7 +37,25 @@
     schema_unmarshallers_factory=oas30_response_schema_unmarshallers_factory,
 )
 
+openapi_v31_response_data_validator = ResponseDataValidator(
+    schema_unmarshallers_factory=oas31_schema_unmarshallers_factory,
+)
+openapi_v31_response_headers_validator = ResponseHeadersValidator(
+    schema_unmarshallers_factory=oas31_schema_unmarshallers_factory,
+)
+openapi_v31_response_validator = ResponseValidator(
+    schema_unmarshallers_factory=oas31_schema_unmarshallers_factory,
+)
+
 # alias to the latest v3 version
-openapi_response_data_validator = openapi_v30_response_data_validator
-openapi_response_headers_validator = openapi_v30_response_headers_validator
-openapi_response_validator = openapi_v30_response_validator
+openapi_response_data_validator = openapi_v31_response_data_validator
+openapi_response_headers_validator = openapi_v31_response_headers_validator
+openapi_response_validator = openapi_v31_response_validator
+
+# detect version spec
+openapi_response_validator_proxy = DetectResponseValidatorProxy(
+    {
+        ("openapi", "3.0"): openapi_v30_response_validator,
+        ("openapi", "3.1"): openapi_v31_response_validator,
+    },
+)

openapi_core/validation/response/proxies.py

@@ -0,0 +1,62 @@
+"""OpenAPI spec validator validation proxies module."""
+from typing import Any
+from typing import Hashable
+from typing import Iterator
+from typing import Mapping
+from typing import Optional
+from typing import Tuple
+
+from openapi_core.exceptions import OpenAPIError
+from openapi_core.spec import Spec
+from openapi_core.validation.exceptions import ValidatorDetectError
+from openapi_core.validation.request.protocols import Request
+from openapi_core.validation.response.datatypes import ResponseValidationResult
+from openapi_core.validation.response.protocols import Response
+from openapi_core.validation.response.validators import ResponseValidator
+
+
+class DetectResponseValidatorProxy:
+    def __init__(self, choices: Mapping[Tuple[str, str], ResponseValidator]):
+        self.choices = choices
+
+    def detect(self, spec: Spec) -> ResponseValidator:
+        for (key, value), validator in self.choices.items():
+            if key in spec and spec[key].startswith(value):
+                return validator
+        raise ValidatorDetectError("Spec schema version not detected")
+
+    def validate(
+        self,
+        spec: Spec,
+        request: Request,
+        response: Response,
+        base_url: Optional[str] = None,
+    ) -> ResponseValidationResult:
+        validator = self.detect(spec)
+        return validator.validate(spec, request, response, base_url=base_url)
+
+    def is_valid(
+        self,
+        spec: Spec,
+        request: Request,
+        response: Response,
+        base_url: Optional[str] = None,
+    ) -> bool:
+        validator = self.detect(spec)
+        error = next(
+            validator.iter_errors(spec, request, response, base_url=base_url),
+            None,
+        )
+        return error is None
+
+    def iter_errors(
+        self,
+        spec: Spec,
+        request: Request,
+        response: Response,
+        base_url: Optional[str] = None,
+    ) -> Iterator[OpenAPIError]:
+        validator = self.detect(spec)
+        yield from validator.iter_errors(
+            spec, request, response, base_url=base_url
+        )

openapi_core/validation/response/validators.py

@@ -2,6 +2,7 @@
 import warnings
 from typing import Any
 from typing import Dict
+from typing import Iterator
 from typing import List
 from typing import Optional
 
@@ -30,6 +31,16 @@
 
 
 class BaseResponseValidator(BaseValidator):
+    def iter_errors(
+        self,
+        spec: Spec,
+        request: Request,
+        response: Response,
+        base_url: Optional[str] = None,
+    ) -> Iterator[OpenAPIError]:
+        result = self.validate(spec, request, response, base_url=base_url)
+        yield from result.errors
+
     def validate(
         self,
         spec: Spec,

openapi_core/validation/shortcuts.py

@@ -2,11 +2,11 @@
 from typing import Optional
 
 from openapi_core.spec import Spec
-from openapi_core.validation.request import openapi_request_validator
+from openapi_core.validation.request import openapi_request_validator_proxy
 from openapi_core.validation.request.datatypes import RequestValidationResult
 from openapi_core.validation.request.protocols import Request
 from openapi_core.validation.request.validators import RequestValidator
-from openapi_core.validation.response import openapi_response_validator
+from openapi_core.validation.response import openapi_response_validator_proxy
 from openapi_core.validation.response.datatypes import ResponseValidationResult
 from openapi_core.validation.response.protocols import Response
 from openapi_core.validation.response.validators import ResponseValidator
@@ -16,7 +16,7 @@ def validate_request(
     spec: Spec,
     request: Request,
     base_url: Optional[str] = None,
-    validator: RequestValidator = openapi_request_validator,
+    validator: RequestValidator = openapi_request_validator_proxy,
 ) -> RequestValidationResult:
     result = validator.validate(spec, request, base_url=base_url)
     result.raise_for_errors()
@@ -28,7 +28,7 @@ def validate_response(
     request: Request,
     response: Response,
     base_url: Optional[str] = None,
-    validator: ResponseValidator = openapi_response_validator,
+    validator: ResponseValidator = openapi_response_validator_proxy,
 ) -> ResponseValidationResult:
     result = validator.validate(spec, request, response, base_url=base_url)
     result.raise_for_errors()