Merge pull request #411 from p1c2u/fix/removed-shortcuts-docs-update

p1c2u · web-flow · commit 20526b34b9df · 2022-09-06T18:04:11.000+01:00
Fix/removed shortcuts docs update
diff --git a/README.rst b/README.rst
@@ -76,10 +76,9 @@ Now you can use it to validate against requests
 
 .. code-block:: python
 
-   from openapi_core.validation.request.validators import RequestValidator
+   from openapi_core.validation.request import openapi_request_validator
 
-   validator = RequestValidator(spec)
-   result = validator.validate(request)
+   result = openapi_request_validator.validate(spec, request)
 
    # raise errors if request invalid
    result.raise_for_errors()
@@ -111,10 +110,9 @@ You can also validate against responses
 
 .. code-block:: python
 
-   from openapi_core.validation.response.validators import ResponseValidator
+   from openapi_core.validation.response import openapi_response_validator
 
-   validator = ResponseValidator(spec)
-   result = validator.validate(request, response)
+   result = openapi_response_validator.validate(spec, request, response)
 
    # raise errors if response invalid
    result.raise_for_errors()
diff --git a/docs/customizations.rst b/docs/customizations.rst
@@ -29,9 +29,9 @@ Pass custom defined media type deserializers dictionary with supported mimetypes
    }
 
    validator = ResponseValidator(
-       spec, custom_media_type_deserializers=custom_media_type_deserializers)
+       custom_media_type_deserializers=custom_media_type_deserializers)
 
-   result = validator.validate(request, response)
+   result = validator.validate(spec, request, response)
 
 Formats
 -------
@@ -59,7 +59,7 @@ Here's how you could add support for a ``usdate`` format that handles dates of t
        'usdate': USDateFormatter(),
    }
 
-   validator = ResponseValidator(spec, custom_formatters=custom_formatters)
+   validator = ResponseValidator(custom_formatters=custom_formatters)
 
-   result = validator.validate(request, response)
+   result = validator.validate(spec, request, response)
 
diff --git a/docs/integrations.rst b/docs/integrations.rst
@@ -56,23 +56,21 @@ You can use `DjangoOpenAPIRequest` as a Django request factory:
 
 .. code-block:: python
 
-   from openapi_core.validation.request.validators import RequestValidator
+   from openapi_core.validation.request import openapi_request_validator
    from openapi_core.contrib.django import DjangoOpenAPIRequest
 
    openapi_request = DjangoOpenAPIRequest(django_request)
-   validator = RequestValidator(spec)
-   result = validator.validate(openapi_request)
+   result = openapi_request_validator.validate(spec, openapi_request)
 
 You can use `DjangoOpenAPIResponse` as a Django response factory:
 
 .. code-block:: python
 
-   from openapi_core.validation.response.validators import ResponseValidator
+   from openapi_core.validation.response import openapi_respose_validator
    from openapi_core.contrib.django import DjangoOpenAPIResponse
 
    openapi_response = DjangoOpenAPIResponse(django_response)
-   validator = ResponseValidator(spec)
-   result = validator.validate(openapi_request, openapi_response)
+   result = openapi_respose_validator.validate(spec, openapi_request, openapi_response)
 
 
 Falcon
@@ -117,23 +115,21 @@ You can use `FalconOpenAPIRequest` as a Falcon request factory:
 
 .. code-block:: python
 
-   from openapi_core.validation.request.validators import RequestValidator
-   from openapi_core.contrib.falcon import FalconOpenAPIRequestFactory
+   from openapi_core.validation.request import openapi_request_validator
+   from openapi_core.contrib.falcon import FalconOpenAPIRequest
 
-   openapi_request = FalconOpenAPIRequestFactory().create(falcon_request)
-   validator = RequestValidator(spec)
-   result = validator.validate(openapi_request)
+   openapi_request = FalconOpenAPIRequest(falcon_request)
+   result = openapi_request_validator.validate(spec, openapi_request)
 
 You can use `FalconOpenAPIResponse` as a Falcon response factory:
 
 .. code-block:: python
 
-   from openapi_core.validation.response.validators import ResponseValidator
-   from openapi_core.contrib.falcon import FalconOpenAPIResponseFactory
+   from openapi_core.validation.response import openapi_respose_validator
+   from openapi_core.contrib.falcon import FalconOpenAPIResponse
 
-   openapi_response = FalconOpenAPIResponseFactory().create(falcon_response)
-   validator = ResponseValidator(spec)
-   result = validator.validate(openapi_request, openapi_response)
+   openapi_response = FalconOpenAPIResponse(falcon_response)
+   result = openapi_respose_validator.validate(spec, openapi_request, openapi_response)
 
 
 Flask
@@ -200,23 +196,21 @@ You can use `FlaskOpenAPIRequest` as a Flask/Werkzeug request factory:
 
 .. code-block:: python
 
-   from openapi_core.validation.request.validators import RequestValidator
+   from openapi_core.validation.request import openapi_request_validator
    from openapi_core.contrib.flask import FlaskOpenAPIRequest
 
    openapi_request = FlaskOpenAPIRequest(flask_request)
-   validator = RequestValidator(spec)
-   result = validator.validate(openapi_request)
+   result = openapi_request_validator.validate(spec, openapi_request)
 
 You can use `FlaskOpenAPIResponse` as a Flask/Werkzeug response factory:
 
 .. code-block:: python
 
-   from openapi_core.validation.response.validators import ResponseValidator
+   from openapi_core.validation.response import openapi_response_validator
    from openapi_core.contrib.flask import FlaskOpenAPIResponse
 
    openapi_response = FlaskOpenAPIResponse(flask_response)
-   validator = ResponseValidator(spec)
-   result = validator.validate(openapi_request, openapi_response)
+   result = openapi_response_validator.validate(spec, openapi_request, openapi_response)
 
 
 Pyramid
@@ -237,23 +231,21 @@ You can use `RequestsOpenAPIRequest` as a Requests request factory:
 
 .. code-block:: python
 
-   from openapi_core.validation.request.validators import RequestValidator
+   from openapi_core.validation.request import openapi_request_validator
    from openapi_core.contrib.requests import RequestsOpenAPIRequest
 
    openapi_request = RequestsOpenAPIRequest(requests_request)
-   validator = RequestValidator(spec)
-   result = validator.validate(openapi_request)
+   result = openapi_request_validator.validate(spec, openapi_request)
 
 You can use `RequestsOpenAPIResponse` as a Requests response factory:
 
 .. code-block:: python
 
-   from openapi_core.validation.response.validators import ResponseValidator
+   from openapi_core.validation.response import openapi_respose_validator
    from openapi_core.contrib.requests import RequestsOpenAPIResponse
 
    openapi_response = RequestsOpenAPIResponse(requests_response)
-   validator = ResponseValidator(spec)
-   result = validator.validate(openapi_request, openapi_response)
+   result = openapi_respose_validator.validate(spec, openapi_request, openapi_response)
 
 Tornado
 -------
diff --git a/docs/usage.rst b/docs/usage.rst
@@ -21,10 +21,9 @@ Now you can use it to validate against requests
 
 .. code-block:: python
 
-   from openapi_core.validation.request.validators import RequestValidator
+   from openapi_core.validation.request import openapi_request_validator
 
-   validator = RequestValidator(spec)
-   result = validator.validate(request)
+   result = validator.validate(spec, request)
 
    # raise errors if request invalid
    result.raise_for_errors()
@@ -56,10 +55,9 @@ You can also validate against responses
 
 .. code-block:: python
 
-   from openapi_core.validation.response.validators import ResponseValidator
+   from openapi_core.validation.response import openapi_response_validator
 
-   validator = ResponseValidator(spec)
-   result = validator.validate(request, response)
+   result = validator.validate(spec, request, response)
 
    # raise errors if response invalid
    result.raise_for_errors()
