Skip to content

Commit fd0a07d

Browse files
committed
Clarify webhooks are for openapi 3.1
1 parent 83a06e9 commit fd0a07d

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

README.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ Use ``validate_request`` function to validate request against a given spec.
8282
8383
Request object should implement OpenAPI Request protocol (See `Integrations <https://openapi-core.readthedocs.io/en/latest/integrations.html>`__).
8484

85-
Use the same function to validate webhook request against a given spec.
85+
(For OpenAPI v3.1) Use the same function to validate webhook request against a given spec.
8686

8787
.. code-block:: python
8888
@@ -120,7 +120,7 @@ Use ``validate_response`` function to validate response against a given spec.
120120
121121
Response object should implement OpenAPI Response protocol (See `Integrations <https://openapi-core.readthedocs.io/en/latest/integrations.html>`__).
122122

123-
Use the same function to validate response from webhook request against a given spec.
123+
(For OpenAPI v3.1) Use the same function to validate response from webhook request against a given spec.
124124

125125
.. code-block:: python
126126

docs/usage.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Use ``validate_request`` function to validate request against a given spec. By d
2525
2626
Request object should implement OpenAPI Request protocol (See :doc:`integrations`).
2727

28-
Use the same function to validate webhook request against a given spec.
28+
(For OpenAPI v3.1) Use the same function to validate webhook request against a given spec.
2929

3030
.. code-block:: python
3131
@@ -63,7 +63,7 @@ Use ``validate_response`` function to validate response against a given spec. By
6363
6464
Response object should implement OpenAPI Response protocol (See :doc:`integrations`).
6565

66-
Use the same function to validate response from webhook request against a given spec.
66+
(For OpenAPI v3.1) Use the same function to validate response from webhook request against a given spec.
6767

6868
.. code-block:: python
6969

0 commit comments

Comments
 (0)