Merge branch 'master' into fix-integer-index

Author: arajkumar

doc/conf.py

@@ -52,7 +52,7 @@
 
 # General information about the project.
 project = u"Flask-RESTX"
-copyright = u"2014, Axel Haustant"
+copyright = u"2020, python-restx Authors"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -263,7 +263,7 @@
         "index",
         "Flask-RESTX.tex",
         u"Flask-RESTX Documentation",
-        u"Axel Haustant",
+        u"python-restx Authors",
         "manual",
     ),
 ]
@@ -294,7 +294,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ("index", "flask-restx", u"Flask-RESTX Documentation", [u"Axel Haustant"], 1)
+    ("index", "flask-restx", u"Flask-RESTX Documentation", [u"python-restx Authors"], 1)
 ]
 
 # If true, show URL addresses after external links.
@@ -311,7 +311,7 @@
         "index",
         "Flask-RESTX",
         u"Flask-RESTX Documentation",
-        u"Axel Haustant",
+        u"python-restx Authors",
         "Flask-RESTX",
         "One line description of project.",
         "Miscellaneous",

doc/configuration.rst

@@ -0,0 +1,65 @@
+Configuration
+=============
+
+Flask-RESTX provides the following `Flask configuration values <https://flask.palletsprojects.com/en/1.1.x/config/#configuration-handling>`_:
+
+    Note: Values with no additional description should be covered in more detail
+    elsewhere in the documentation. If not, please open an issue on GitHub.
+
+.. py:data:: RESTX_JSON
+
+    Provide global configuration options for JSON serialisation as a :class:`dict`
+    of :func:`json.dumps` keyword arguments.
+
+.. py:data:: RESTX_VALIDATE
+
+   Whether to enforce payload validation by default when using the
+   ``@api.expect()`` decorator. See the `@api.expect()
+   <swagger.html#the-api-expect-decorator>`__ documentation for details.
+   This setting defaults to ``False``.
+
+.. py:data:: RESTX_MASK_HEADER
+
+  Choose the name of the *Header* that will contain the masks to apply to your
+  answer. See the `Fields masks <mask.html>`__ documentation for details.
+  This setting defaults to ``X-Fields``.
+
+.. py:data:: RESTX_MASK_SWAGGER
+
+  Whether to enable the mask documentation in your swagger or not. See the
+  `mask usage <mask.html#usage>`__ documentation for details.
+  This setting defaults to ``True``.
+
+.. py:data:: RESTX_INCLUDE_ALL_MODELS
+
+  This option allows you to include all defined models in the generated Swagger
+  documentation, even if they are not explicitly used in either ``expect`` nor
+  ``marshal_with`` decorators.
+  This setting defaults to ``False``.
+
+.. py:data:: BUNDLE_ERRORS
+
+  Bundle all the validation errors instead of returning only the first one
+  encountered. See the `Error Handling <parsing.html#error-handling>`__ section
+  of the documentation for details.
+  This setting defaults to ``False``.
+
+.. py:data:: ERROR_404_HELP
+
+.. py:data:: HTTP_BASIC_AUTH_REALM
+
+.. py:data:: SWAGGER_VALIDATOR_URL
+
+.. py:data:: SWAGGER_UI_DOC_EXPANSION
+
+.. py:data:: SWAGGER_UI_OPERATION_ID
+
+.. py:data:: SWAGGER_UI_REQUEST_DURATION
+
+.. py:data:: SWAGGER_UI_OAUTH_APP_NAME
+
+.. py:data:: SWAGGER_UI_OAUTH_CLIENT_ID
+
+.. py:data:: SWAGGER_UI_OAUTH_REALM
+
+.. py:data:: SWAGGER_SUPPORTED_SUBMIT_METHODS

doc/index.rst

@@ -55,6 +55,7 @@ Flask-RESTX with Flask.
     postman
     scaling
     example
+    configuration
 
 
 API Reference

doc/marshalling.rst

@@ -521,7 +521,7 @@ You can define models using `JSON Schema <http://json-schema.org/examples.html>`
         'type': 'object'
     })
 
-    person = address = api.schema_model('Person', {
+    person = api.schema_model('Person', {
         'required': ['address'],
         'properties': {
             'name': {

examples/complex.py

@@ -1,5 +1,5 @@
 from flask import Flask
-from werkzeug.contrib.fixers import ProxyFix
+from werkzeug.middleware.proxy_fix import ProxyFix
 
 from zoo import api
 

examples/todo.py

@@ -1,6 +1,6 @@
 from flask import Flask
 from flask_restx import Api, Resource, fields
-from werkzeug.contrib.fixers import ProxyFix
+from werkzeug.middleware.proxy_fix import ProxyFix
 
 app = Flask(__name__)
 app.wsgi_app = ProxyFix(app.wsgi_app)

examples/todomvc.py

@@ -1,6 +1,6 @@
 from flask import Flask
 from flask_restx import Api, Resource, fields
-from werkzeug.contrib.fixers import ProxyFix
+from werkzeug.middleware.proxy_fix import ProxyFix
 
 app = Flask(__name__)
 app.wsgi_app = ProxyFix(app.wsgi_app)