Skip to content

Commit bf2f13d

Browse files
authored
Merge pull request #364 from MichaelCurrin/docs-update-integrations
docs: update integrations.rst
2 parents e0637b5 + 77c00cf commit bf2f13d

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

docs/integrations.rst

+17-17
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Integrations
44
Bottle
55
------
66

7-
See `bottle-openapi-3 <https://github.com/cope-systems/bottle-openapi-3>`_ project.
7+
See `bottle-openapi-3 <https://github.com/cope-systems/bottle-openapi-3>`_ project.
88

99

1010
Django
@@ -16,7 +16,7 @@ The integration supports Django from version 3.0 and above.
1616
Middleware
1717
~~~~~~~~~~
1818

19-
Django can be integrated by middleware. Add `DjangoOpenAPIMiddleware` to your `MIDDLEWARE` list and define `OPENAPI_SPEC`
19+
Django can be integrated by middleware. Add `DjangoOpenAPIMiddleware` to your `MIDDLEWARE` list and define `OPENAPI_SPEC`.
2020

2121
.. code-block:: python
2222
@@ -30,7 +30,7 @@ Django can be integrated by middleware. Add `DjangoOpenAPIMiddleware` to your `M
3030
3131
OPENAPI_SPEC = create_spec(spec_dict)
3232
33-
After that you have access to validation result object with all validated request data from Django view through request object
33+
After that you have access to validation result object with all validated request data from Django view through request object.
3434

3535
.. code-block:: python
3636
@@ -52,7 +52,7 @@ After that you have access to validation result object with all validated reques
5252
Low level
5353
~~~~~~~~~
5454

55-
For Django you can use DjangoOpenAPIRequest a Django request factory:
55+
You can use `DjangoOpenAPIRequest` as a Django request factory:
5656

5757
.. code-block:: python
5858
@@ -63,7 +63,7 @@ For Django you can use DjangoOpenAPIRequest a Django request factory:
6363
validator = RequestValidator(spec)
6464
result = validator.validate(openapi_request)
6565
66-
You can use DjangoOpenAPIResponse as a Django response factory:
66+
You can use `DjangoOpenAPIResponse` as a Django response factory:
6767

6868
.. code-block:: python
6969
@@ -84,7 +84,7 @@ The integration supports Falcon from version 3.0 and above.
8484
Middleware
8585
~~~~~~~~~~
8686

87-
Falcon API can be integrated by `FalconOpenAPIMiddleware` middleware.
87+
The Falcon API can be integrated by `FalconOpenAPIMiddleware` middleware.
8888

8989
.. code-block:: python
9090
@@ -93,7 +93,7 @@ Falcon API can be integrated by `FalconOpenAPIMiddleware` middleware.
9393
openapi_middleware = FalconOpenAPIMiddleware.from_spec(spec)
9494
app = falcon.App(middleware=[openapi_middleware])
9595
96-
After that you will have access to validation result object with all validated request data from Falcon view through request context
96+
After that you will have access to validation result object with all validated request data from Falcon view through request context.
9797

9898
.. code-block:: python
9999
@@ -113,7 +113,7 @@ After that you will have access to validation result object with all validated r
113113
Low level
114114
~~~~~~~~~
115115

116-
For Falcon you can use FalconOpenAPIRequest a Falcon request factory:
116+
You can use `FalconOpenAPIRequest` as a Falcon request factory:
117117

118118
.. code-block:: python
119119
@@ -124,7 +124,7 @@ For Falcon you can use FalconOpenAPIRequest a Falcon request factory:
124124
validator = RequestValidator(spec)
125125
result = validator.validate(openapi_request)
126126
127-
You can use FalconOpenAPIResponse as a Falcon response factory:
127+
You can use `FalconOpenAPIResponse` as a Falcon response factory:
128128

129129
.. code-block:: python
130130
@@ -167,7 +167,7 @@ If you want to decorate class based view you can use the decorators attribute:
167167
View
168168
~~~~
169169

170-
As an alternative to the decorator-based integration, Flask method based views can be integrated by inheritance from `FlaskOpenAPIView` class.
170+
As an alternative to the decorator-based integration, a Flask method based views can be integrated by inheritance from `FlaskOpenAPIView` class.
171171

172172
.. code-block:: python
173173
@@ -181,7 +181,7 @@ As an alternative to the decorator-based integration, Flask method based views c
181181
Request parameters
182182
~~~~~~~~~~~~~~~~~~
183183

184-
In Flask, all unmarshalled request data are provided as Flask request object's openapi.parameters attribute
184+
In Flask, all unmarshalled request data are provided as Flask request object's `openapi.parameters` attribute
185185

186186
.. code-block:: python
187187
@@ -196,7 +196,7 @@ In Flask, all unmarshalled request data are provided as Flask request object's o
196196
Low level
197197
~~~~~~~~~
198198

199-
You can use FlaskOpenAPIRequest a Flask/Werkzeug request factory:
199+
You can use `FlaskOpenAPIRequest` as a Flask/Werkzeug request factory:
200200

201201
.. code-block:: python
202202
@@ -207,7 +207,7 @@ You can use FlaskOpenAPIRequest a Flask/Werkzeug request factory:
207207
validator = RequestValidator(spec)
208208
result = validator.validate(openapi_request)
209209
210-
You can use FlaskOpenAPIResponse as a Flask/Werkzeug response factory:
210+
You can use `FlaskOpenAPIResponse` as a Flask/Werkzeug response factory:
211211

212212
.. code-block:: python
213213
@@ -222,7 +222,7 @@ You can use FlaskOpenAPIResponse as a Flask/Werkzeug response factory:
222222
Pyramid
223223
-------
224224

225-
See `pyramid_openapi3 <https://github.com/niteoweb/pyramid_openapi3>`_ project.
225+
See `pyramid_openapi3 <https://github.com/niteoweb/pyramid_openapi3>`_ project.
226226

227227

228228
Requests
@@ -233,7 +233,7 @@ This section describes integration with `Requests <https://requests.readthedocs.
233233
Low level
234234
~~~~~~~~~
235235

236-
For Requests you can use RequestsOpenAPIRequest a Requests request factory:
236+
You can use `RequestsOpenAPIRequest` as a Requests request factory:
237237

238238
.. code-block:: python
239239
@@ -244,7 +244,7 @@ For Requests you can use RequestsOpenAPIRequest a Requests request factory:
244244
validator = RequestValidator(spec)
245245
result = validator.validate(openapi_request)
246246
247-
You can use RequestsOpenAPIResponse as a Requests response factory:
247+
You can use `RequestsOpenAPIResponse` as a Requests response factory:
248248

249249
.. code-block:: python
250250
@@ -258,4 +258,4 @@ You can use RequestsOpenAPIResponse as a Requests response factory:
258258
Tornado
259259
-------
260260

261-
See `tornado-openapi3 <https://github.com/correl/tornado-openapi3>`_ project.
261+
See `tornado-openapi3 <https://github.com/correl/tornado-openapi3>`_ project.

0 commit comments

Comments
 (0)