Merge pull request #232 from python-openapi/fix/update-supports-validation-protocol

Update SupportsValidation protocol

Author: p1c2u

openapi_spec_validator/shortcuts.py

@@ -2,6 +2,7 @@
 from typing import Any
 from typing import Hashable
 from typing import Mapping
+from typing import Optional
 
 from jsonschema_spec.handlers import all_urls_handler
 
@@ -11,15 +12,16 @@
 
 def validate_spec(
     spec: Mapping[Hashable, Any],
-    spec_url: str = "",
+    base_uri: str = "",
     validator: SupportsValidation = openapi_spec_validator_proxy,
+    spec_url: Optional[str] = None,
 ) -> None:
-    return validator.validate(spec, spec_url=spec_url)
+    return validator.validate(spec, base_uri=base_uri, spec_url=spec_url)
 
 
 def validate_spec_url(
     spec_url: str,
     validator: SupportsValidation = openapi_spec_validator_proxy,
 ) -> None:
     spec = all_urls_handler(spec_url)
-    return validator.validate(spec, spec_url=spec_url)
+    return validator.validate(spec, base_uri=spec_url)

openapi_spec_validator/validation/protocols.py

@@ -2,6 +2,7 @@
 from typing import Hashable
 from typing import Iterator
 from typing import Mapping
+from typing import Optional
 from typing import Protocol
 from typing import runtime_checkable
 
@@ -14,11 +15,17 @@ def is_valid(self, instance: Mapping[Hashable, Any]) -> bool:
         ...
 
     def iter_errors(
-        self, instance: Mapping[Hashable, Any], spec_url: str = ""
+        self,
+        instance: Mapping[Hashable, Any],
+        base_uri: str = "",
+        spec_url: Optional[str] = None,
     ) -> Iterator[OpenAPIValidationError]:
         ...
 
     def validate(
-        self, instance: Mapping[Hashable, Any], spec_url: str = ""
+        self,
+        instance: Mapping[Hashable, Any],
+        base_uri: str = "",
+        spec_url: Optional[str] = None,
     ) -> None:
         ...

openapi_spec_validator/validation/proxies.py

@@ -3,6 +3,7 @@
 from typing import Hashable
 from typing import Iterator
 from typing import Mapping
+from typing import Optional
 from typing import Tuple
 
 from openapi_spec_validator.validation.exceptions import OpenAPIValidationError
@@ -21,10 +22,15 @@ def detect(self, instance: Mapping[Hashable, Any]) -> SpecValidator:
         raise ValidatorDetectError("Spec schema version not detected")
 
     def validate(
-        self, instance: Mapping[Hashable, Any], spec_url: str = ""
+        self,
+        instance: Mapping[Hashable, Any],
+        base_uri: str = "",
+        spec_url: Optional[str] = None,
     ) -> None:
         validator = self.detect(instance)
-        for err in validator.iter_errors(instance, spec_url=spec_url):
+        for err in validator.iter_errors(
+            instance, base_uri=base_uri, spec_url=spec_url
+        ):
             raise err
 
     def is_valid(self, instance: Mapping[Hashable, Any]) -> bool:
@@ -33,7 +39,12 @@ def is_valid(self, instance: Mapping[Hashable, Any]) -> bool:
         return error is None
 
     def iter_errors(
-        self, instance: Mapping[Hashable, Any], spec_url: str = ""
+        self,
+        instance: Mapping[Hashable, Any],
+        base_uri: str = "",
+        spec_url: Optional[str] = None,
     ) -> Iterator[OpenAPIValidationError]:
         validator = self.detect(instance)
-        yield from validator.iter_errors(instance, spec_url=spec_url)
+        yield from validator.iter_errors(
+            instance, base_uri=base_uri, spec_url=spec_url
+        )