Merge pull request #413 from p1c2u/feature/get-rid-of-openapiv3-prefix-for-spec

get rid of openapiv3 prefix for spec

Author: p1c2u

README.rst

@@ -62,7 +62,7 @@ Firstly create your specification object:
 .. code-block:: python
 
    from json import load
-   from openapi_core import OpenAPISpec as Spec
+   from openapi_core import Spec
 
    with open('openapi.json', 'r') as spec_file:
       spec_dict = load(spec_file)

docs/customizations.rst

@@ -4,13 +4,13 @@ Customizations
 Spec validation
 ---------------
 
-By default, spec dict is validated on spec creation time. Disabling the validation can improve the performance.
+By default, spec dict is validated on spec creation time. Disabling the validator can improve the performance.
 
 .. code-block:: python
 
-   from openapi_core import OpenAPISpec as Spec
+   from openapi_core import Spec
 
-   spec = Spec.create(spec_dict, validate=False)
+   spec = Spec.create(spec_dict, validator=False)
 
 Deserializers
 -------------

docs/integrations.rst

@@ -21,7 +21,7 @@ Django can be integrated by middleware. Add `DjangoOpenAPIMiddleware` to your `M
 .. code-block:: python
 
    # settings.py
-   from openapi_core import OpenAPISpec as Spec
+   from openapi_core import Spec
 
    MIDDLEWARE = [
        # ...

docs/usage.rst

@@ -6,7 +6,7 @@ Firstly create your specification: object
 .. code-block:: python
 
    from json import load
-   from openapi_core import OpenAPISpec as Spec
+   from openapi_core import Spec
 
    with open('openapi.json', 'r') as spec_file:
       spec_dict = load(spec_file)

openapi_core/__init__.py

@@ -1,5 +1,5 @@
 """OpenAPI core module"""
-from openapi_core.spec import OpenAPIv30Spec
+from openapi_core.spec import Spec
 from openapi_core.validation.request.validators import RequestBodyValidator
 from openapi_core.validation.request.validators import (
     RequestParametersValidator,
@@ -21,9 +21,7 @@
 __license__ = "BSD 3-Clause License"
 
 __all__ = [
-    "OpenAPIv30Spec",
-    "OpenAPIv3Spec",
-    "OpenAPISpec",
+    "Spec",
     "validate_request",
     "validate_response",
     "RequestValidator",
@@ -34,9 +32,3 @@
     "ResponseDataValidator",
     "ResponseHeadersValidator",
 ]
-
-# aliases to the latest v3 version
-OpenAPIv3Spec = OpenAPIv30Spec
-
-# aliases to the latest version
-OpenAPISpec = OpenAPIv3Spec

openapi_core/spec/__init__.py

@@ -1,5 +1,3 @@
-from openapi_core.spec.paths import OpenAPIv30Spec
+from openapi_core.spec.paths import Spec
 
-__all__ = [
-    "OpenAPIv30Spec",
-]
+__all__ = ["Spec"]

openapi_core/spec/paths.py

@@ -24,11 +24,6 @@ def from_dict(
         accessor = SpecAccessor(data, dereferencer)
         return cls(accessor, *args, separator=separator)
 
-
-class OpenAPIv30Spec(Spec):
-
-    validator = openapi_v3_spec_validator
-
     @classmethod
     def create(
         cls,
@@ -37,10 +32,10 @@ def create(
         url="",
         ref_resolver_handlers=default_handlers,
         separator=SPEC_SEPARATOR,
-        validate=True,
+        validator=openapi_v3_spec_validator,
     ):
-        if validate:
-            cls.validator.validate(data, spec_url=url)
+        if validator is not None:
+            validator.validate(data, spec_url=url)
 
         return cls.from_dict(
             data,

openapi_core/templating/paths/util.py

@@ -1,6 +1,6 @@
 from typing import Tuple
 
-from openapi_core.spec.paths import OpenAPIv30Spec as Spec
+from openapi_core.spec.paths import Spec
 from openapi_core.templating.datatypes import TemplateResult
 
 

tests/integration/contrib/django/data/v3.0/djangoproject/settings.py

@@ -15,7 +15,7 @@
 
 import yaml
 
-from openapi_core import OpenAPISpec as Spec
+from openapi_core import Spec
 
 # Build paths inside the project like this: os.path.join(BASE_DIR, ...)
 BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))

tests/integration/contrib/falcon/data/v3.0/falconproject/openapi.py

@@ -2,7 +2,7 @@
 
 import yaml
 
-from openapi_core import OpenAPISpec as Spec
+from openapi_core import Spec
 from openapi_core.contrib.falcon.middlewares import FalconOpenAPIMiddleware
 
 openapi_spec_path = Path("tests/integration/data/v3.0/petstore.yaml")