Merge pull request #187 from maho/strict-validation-pr

fix #186 - allow strict mode when validating model fields

Author: ziirish

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_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"][""])