Skip to content

Commit 2983194

Browse files
authored
Improve Requests integration documentation
Include the import examples to make it explicit (Explicit is better than implicit) and fix a small typo in the code.
1 parent 103d794 commit 2983194

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/integrations/requests.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Request
1414
Use ``RequestsOpenAPIRequest`` to create OpenAPI request from Requests request:
1515

1616
.. code-block:: python
17-
17+
from requests import Request, Session
1818
from openapi_core.contrib.requests import RequestsOpenAPIRequest
1919
2020
request = Request('POST', url, data=data, headers=headers)
@@ -27,7 +27,7 @@ Webhook request
2727
Use ``RequestsOpenAPIWebhookRequest`` to create OpenAPI webhook request from Requests request:
2828

2929
.. code-block:: python
30-
30+
from requests import Request, Session
3131
from openapi_core.contrib.requests import RequestsOpenAPIWebhookRequest
3232
3333
request = Request('POST', url, data=data, headers=headers)
@@ -40,13 +40,13 @@ Response
4040
Use ``RequestsOpenAPIResponse`` to create OpenAPI response from Requests response:
4141

4242
.. code-block:: python
43-
43+
from requests import Request, Session
4444
from openapi_core.contrib.requests import RequestsOpenAPIResponse
4545
4646
session = Session()
4747
request = Request('POST', url, data=data, headers=headers)
4848
prepped = session.prepare_request(req)
49-
response = session,send(prepped)
49+
response = session.send(prepped)
5050
openapi_request = RequestsOpenAPIRequest(request)
5151
openapi_response = RequestsOpenAPIResponse(response)
5252
openapi.validate_response(openapi_request, openapi_response)

0 commit comments

Comments
 (0)