Skip to content

Commit 6b639b9

Browse files
committed
README validation description minor changes
1 parent 7249858 commit 6b639b9

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.rst

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Firstly create your specification:
4747
4848
spec = create_spec(spec_dict)
4949
50-
Now you can use it to validate and unmarshal requests
50+
Now you can use it to validate requests
5151

5252
.. code-block:: python
5353
@@ -59,12 +59,18 @@ Now you can use it to validate and unmarshal requests
5959
# raise errors if request invalid
6060
result.validate()
6161
62-
# get parameters
63-
path_params = result.parameters['path']
64-
query_params = result.parameters['query']
62+
# get list of errors
63+
errors = result.errors
64+
65+
and unmarshal request data from validation result
66+
67+
.. code-block:: python
68+
69+
# get parameters dictionary with path, query, cookies and headers parameters
70+
validated_params = result.parameters
6571
6672
# get body
67-
body = result.body
73+
validated_body = result.body
6874
6975
Request object should implement BaseOpenAPIRequest interface. You can use FlaskOpenAPIRequest a Flask/Werkzeug request wrapper implementation:
7076

0 commit comments

Comments
 (0)