Skip to content

Commit a63f865

Browse files
ziirishSteadBytes
authored andcommitted
doc: improve configuration docs
Initial proposal to improve some of Flask-RESTX' configuration options.
1 parent b47600e commit a63f865

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

doc/configuration.rst

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,37 @@ Flask-RESTX provides the following `Flask configuration values <https://flask.pa
1313

1414
.. py:data:: RESTX_VALIDATE
1515
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+
1621
.. py:data:: RESTX_MASK_HEADER
1722
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+
1827
.. py:data:: RESTX_MASK_SWAGGER
1928
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+
2033
.. py:data:: RESTX_INCLUDE_ALL_MODELS
2134
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+
2240
.. py:data:: BUNDLE_ERRORS
2341
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+
2447
.. py:data:: ERROR_404_HELP
2548
2649
.. py:data:: HTTP_BASIC_AUTH_REALM
@@ -39,4 +62,4 @@ Flask-RESTX provides the following `Flask configuration values <https://flask.pa
3962
4063
.. py:data:: SWAGGER_UI_OAUTH_REALM
4164
42-
.. py:data:: SWAGGER_SUPPORTED_SUBMIT_METHODS
65+
.. py:data:: SWAGGER_SUPPORTED_SUBMIT_METHODS

0 commit comments

Comments
 (0)