Merge branch 'master' into fix-multiple-docs-for-one-endpoint

Author: ProgHaj

doc/quickstart.rst

@@ -225,7 +225,7 @@ You can also match parts of the path as variables to your resource methods.
     If a request does not match any of your application's endpoints,
     Flask-RESTX will return a 404 error message with suggestions of other
     endpoints that closely match the requested endpoint.
-    This can be disabled by setting ``ERROR_404_HELP`` to ``False`` in your application config.
+    This can be disabled by setting ``RESTX_ERROR_404_HELP`` to ``False`` in your application config.
 
 
 Argument Parsing

flask_restx/api.py

@@ -9,6 +9,7 @@
 import re
 import six
 import sys
+import warnings
 
 from collections import OrderedDict
 from functools import wraps, partial
@@ -222,6 +223,7 @@ def init_app(self, app, **kwargs):
         else:
             self.blueprint = app
 
+
     def _init_app(self, app):
         """
         Perform initialization actions with the given :class:`flask.Flask` object.
@@ -253,6 +255,16 @@ def _init_app(self, app):
         app.config.setdefault("RESTX_MASK_SWAGGER", True)
         app.config.setdefault("RESTX_INCLUDE_ALL_MODELS", False)
 
+        # check for deprecated config variable names
+        if "ERROR_404_HELP" in app.config:
+            app.config['RESTX_ERROR_404_HELP'] = app.config['ERROR_404_HELP']
+            warnings.warn(
+                "'ERROR_404_HELP' config setting is deprecated and will be "
+                "removed in the future. Use 'RESTX_ERROR_404_HELP' instead.",
+                DeprecationWarning
+            )
+
+
     def __getattr__(self, name):
         try:
             return getattr(self.default_namespace, name)
@@ -506,11 +518,11 @@ def endpoint(self, name):
     @property
     def specs_url(self):
         """
-        The Swagger specifications absolute url (ie. `swagger.json`)
+        The Swagger specifications relative url (ie. `swagger.json`)
 
         :rtype: str
         """
-        return url_for(self.endpoint("specs"), _external=True)
+        return url_for(self.endpoint("specs"))
 
     @property
     def base_url(self):
@@ -712,7 +724,7 @@ def handle_error(self, e):
 
         elif (
             code == HTTPStatus.NOT_FOUND
-            and current_app.config.get("ERROR_404_HELP", True)
+            and current_app.config.get("RESTX_ERROR_404_HELP", True)
             and include_message_in_response
         ):
             data["message"] = self._help_on_404(data.get("message", None))

flask_restx/fields.py

@@ -156,7 +156,7 @@ def __init__(
         self.description = description
         self.required = required
         self.readonly = readonly
-        self.example = example or self.__schema_example__
+        self.example = example if example is not None else self.__schema_example__
         self.mask = mask
 
     def format(self, value):

flask_restx/model.py

@@ -132,12 +132,14 @@ class RawModel(ModelBase):
 
     :param str name: The model public name
     :param str mask: an optional default model mask
+    :param bool strict: validation should raise error when there is param not provided in schema
     """
 
     wrapper = dict
 
     def __init__(self, name, *args, **kwargs):
         self.__mask__ = kwargs.pop("mask", None)
+        self.__strict__ = kwargs.pop("strict", False)
         if self.__mask__ and not isinstance(self.__mask__, Mask):
             self.__mask__ = Mask(self.__mask__)
         super(RawModel, self).__init__(name, *args, **kwargs)
@@ -160,15 +162,18 @@ def _schema(self):
             if getattr(field, "discriminator", False):
                 discriminator = name
 
-        return not_none(
-            {
-                "required": sorted(list(required)) or None,
-                "properties": properties,
-                "discriminator": discriminator,
-                "x-mask": str(self.__mask__) if self.__mask__ else None,
-                "type": "object",
-            }
-        )
+        definition = {
+            "required": sorted(list(required)) or None,
+            "properties": properties,
+            "discriminator": discriminator,
+            "x-mask": str(self.__mask__) if self.__mask__ else None,
+            "type": "object",
+        }
+
+        if self.__strict__:
+            definition['additionalProperties'] = False
+
+        return not_none(definition)
 
     @cached_property
     def resolved(self):
@@ -240,6 +245,7 @@ def __deepcopy__(self, memo):
             self.name,
             [(key, copy.deepcopy(value, memo)) for key, value in iteritems(self)],
             mask=self.__mask__,
+            strict=self.__strict__,
         )
         obj.__parents__ = self.__parents__
         return obj

flask_restx/namespace.py

@@ -162,14 +162,17 @@ def add_model(self, name, definition):
             api.models[name] = definition
         return definition
 
-    def model(self, name=None, model=None, mask=None, **kwargs):
+    def model(self, name=None, model=None, mask=None, strict=False, **kwargs):
         """
         Register a model
 
+        :param bool strict - should model validation raise error when non-specified param
+                             is provided?
+
         .. seealso:: :class:`Model`
         """
         cls = OrderedModel if self.ordered else Model
-        model = cls(name, model, mask=mask)
+        model = cls(name, model, mask=mask, strict=strict)
         model.__apidoc__.update(kwargs)
         return self.add_model(name, model)
 

tests/test_errors.py

@@ -480,7 +480,7 @@ def test_handle_smart_errors(self, app):
             assert response.status_code == 404
             assert "did you mean /foo ?" in response.data.decode()
 
-        app.config["ERROR_404_HELP"] = False
+        app.config["RESTX_ERROR_404_HELP"] = False
 
         response = api.handle_error(NotFound())
         assert response.status_code == 404

tests/test_fields.py

@@ -298,6 +298,14 @@ def test_with_default(self):
         assert not field.required
         assert field.__schema__ == {"type": "boolean", "default": True}
 
+    def test_with_example(self):
+        field = fields.Boolean(default=True, example=False)
+        assert field.__schema__ == {
+            "type": "boolean",
+            "default": True,
+            "example": False,
+        }
+
     @pytest.mark.parametrize(
         "value,expected",
         [

tests/test_namespace.py

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 from __future__ import unicode_literals
+import re
 
 import flask_restx as restx
 
@@ -143,3 +144,35 @@ def post(self):
         client.post_json("/apples/validation/", data)
 
         assert Payload.payload == data
+
+    def test_api_payload_strict_verification(self, app, client):
+        api = restx.Api(app, validate=True)
+        ns = restx.Namespace("apples")
+        api.add_namespace(ns)
+
+        fields = ns.model(
+            "Person",
+            {
+                "name": restx.fields.String(required=True),
+                "age": restx.fields.Integer,
+                "birthdate": restx.fields.DateTime,
+            },
+            strict=True,
+        )
+
+        @ns.route("/validation/")
+        class Payload(restx.Resource):
+            payload = None
+
+            @ns.expect(fields)
+            def post(self):
+                Payload.payload = ns.payload
+                return {}
+
+        data = {
+            "name": "John Doe",
+            "agge": 15,  # typo
+        }
+
+        resp = client.post_json("/apples/validation/", data, status=400)
+        assert re.match("Additional properties are not allowed \(u*'agge' was unexpected\)", resp["errors"][""])