@@ -13,14 +13,37 @@ Flask-RESTX provides the following `Flask configuration values <https://flask.pa
13
13
14
14
.. py :data :: RESTX_VALIDATE
15
15
16
+ Whether to enforce payload validation by default when using the
17
+ ``@api.expect() `` decorator. See the `@api.expect()
18
+ <swagger.html#the-api-expect-decorator> `__ documentation for details.
19
+ This setting defaults to ``False ``.
20
+
16
21
.. py :data :: RESTX_MASK_HEADER
17
22
23
+ Choose the name of the *Header * that will contain the masks to apply to your
24
+ answer. See the `Fields masks <mask.html >`__ documentation for details.
25
+ This setting defaults to ``X-Fields ``.
26
+
18
27
.. py :data :: RESTX_MASK_SWAGGER
19
28
29
+ Whether to enable the mask documentation in your swagger or not. See the
30
+ `mask usage <mask.html#usage >`__ documentation for details.
31
+ This setting defaults to ``True ``.
32
+
20
33
.. py :data :: RESTX_INCLUDE_ALL_MODELS
21
34
35
+ This option allows you to include all defined models in the generated Swagger
36
+ documentation, even if they are not explicitly used in either ``expect `` nor
37
+ ``marshal_with `` decorators.
38
+ This setting defaults to ``False ``.
39
+
22
40
.. py :data :: BUNDLE_ERRORS
23
41
42
+ Bundle all the validation errors instead of returning only the first one
43
+ encountered. See the `Error Handling <parsing.html#error-handling >`__ section
44
+ of the documentation for details.
45
+ This setting defaults to ``False ``.
46
+
24
47
.. py :data :: ERROR_404_HELP
25
48
26
49
.. py :data :: HTTP_BASIC_AUTH_REALM
@@ -39,4 +62,4 @@ Flask-RESTX provides the following `Flask configuration values <https://flask.pa
39
62
40
63
.. py :data :: SWAGGER_UI_OAUTH_REALM
41
64
42
- .. py :data :: SWAGGER_SUPPORTED_SUBMIT_METHODS
65
+ .. py :data :: SWAGGER_SUPPORTED_SUBMIT_METHODS
0 commit comments