Docs integrations restructure

python-openapi · Nov 22, 2023 · dc81660 · dc81660
1 parent 88c78dc
commit dc81660
Show file tree

Hide file tree

Showing 4 changed files with 57 additions and 14 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -3,11 +3,11 @@ openapi-core
 
 .. toctree::
     :hidden:
-    :maxdepth: 2
+    :maxdepth: 3
 
     unmarshalling
     validation
-    integrations
+    integrations/index
     customizations
     security
     extensions

diff --git a/docs/integrations.rst b/docs/integrations.rst
@@ -491,22 +491,28 @@ This section describes integration with `Werkzeug <https://werkzeug.palletsproje
 Low level
 ~~~~~~~~~
 
-You can use ``WerkzeugOpenAPIRequest`` as a Werkzeug request factory:
+The integration defines ``WerkzeugOpenAPIRequest`` and ``WerkzeugOpenAPIResponse`` classes that convert
+Werkzeug requests and responses to OpenAPI ones.
 
-.. code-block:: python
+.. md-tab-set::
 
-    from openapi_core import unmarshal_request
-    from openapi_core.contrib.werkzeug import WerkzeugOpenAPIRequest
+    .. md-tab-item:: Request
 
-    openapi_request = WerkzeugOpenAPIRequest(werkzeug_request)
-    result = unmarshal_request(openapi_request, spec=spec)
+      .. code-block:: python
 
-You can use ``WerkzeugOpenAPIResponse`` as a Werkzeug response factory:
+         from openapi_core.contrib.werkzeug import WerkzeugOpenAPIRequest
 
-.. code-block:: python
+         openapi_request = WerkzeugOpenAPIRequest(werkzeug_request)
 
-    from openapi_core import unmarshal_response
-    from openapi_core.contrib.werkzeug import WerkzeugOpenAPIResponse
+         result = openapi.unmarshal_request(openapi_request)
 
-    openapi_response = WerkzeugOpenAPIResponse(werkzeug_response)
-    result = unmarshal_response(openapi_request, openapi_response, spec=spec)
+    .. md-tab-item:: Response
+
+      .. code-block:: python
+
+         from openapi_core.contrib.werkzeug import WerkzeugOpenAPIRequest, WerkzeugOpenAPIResponse
+
+         openapi_request = WerkzeugOpenAPIRequest(werkzeug_request)
+         openapi_response = WerkzeugOpenAPIResponse(werkzeug_response)
+
+         result = openapi.unmarshal_response(openapi_request, openapi_response)
diff --git a/docs/integrations/index.rst b/docs/integrations/index.rst
@@ -0,0 +1,4 @@
+.. toctree::
+    :maxdepth: 2
+
+    werkzeug
diff --git a/docs/integrations/werkzeug.rst b/docs/integrations/werkzeug.rst
@@ -0,0 +1,33 @@
+Werkzeug
+========
+
+This section describes integration with `Werkzeug <https://werkzeug.palletsprojects.com>`__ a WSGI web application library.
+
+Low level
+~~~~~~~~~
+
+The integration defines ``WerkzeugOpenAPIRequest`` and ``WerkzeugOpenAPIResponse`` classes that convert
+Werkzeug requests and responses to OpenAPI ones.
+
+.. md-tab-set::
+
+    .. md-tab-item:: Request
+
+      .. code-block:: python
+
+         from openapi_core.contrib.werkzeug import WerkzeugOpenAPIRequest
+
+         openapi_request = WerkzeugOpenAPIRequest(werkzeug_request)
+
+         result = openapi.unmarshal_request(openapi_request)
+
+    .. md-tab-item:: Response
+
+      .. code-block:: python
+
+         from openapi_core.contrib.werkzeug import WerkzeugOpenAPIRequest, WerkzeugOpenAPIResponse
+
+         openapi_request = WerkzeugOpenAPIRequest(werkzeug_request)
+         openapi_response = WerkzeugOpenAPIResponse(werkzeug_response)
+
+         result = openapi.unmarshal_response(openapi_request, openapi_response)