Merge pull request #988 from marshmallow-code/unknown_default_raise

Set additionnalProperties to False if unknown is not set / support setting unknown at schema instantiation

Author: lafrech

src/apispec/ext/marshmallow/openapi.py

@@ -240,7 +240,7 @@ def list2param(self, field: marshmallow.fields.Field, **kwargs: typing.Any) -> d
 
     def schema2jsonschema(self, schema):
         """Return the JSON Schema Object for a given marshmallow
-        :class:`Schema <marshmallow.Schema>` instance. Schema may optionally
+        :class:`Schema <marshmallow.Schema>`. Schema may optionally
         provide the ``title`` and ``description`` class Meta options.
 
         https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject
@@ -254,12 +254,16 @@ def schema2jsonschema(self, schema):
 
         jsonschema = self.fields2jsonschema(fields, partial=partial)
 
+        schema_instance = resolve_schema_instance(schema)
+
         if hasattr(Meta, "title"):
             jsonschema["title"] = Meta.title
         if hasattr(Meta, "description"):
             jsonschema["description"] = Meta.description
-        if hasattr(Meta, "unknown") and Meta.unknown != marshmallow.EXCLUDE:
-            jsonschema["additionalProperties"] = Meta.unknown == marshmallow.INCLUDE
+        elif schema_instance.unknown != marshmallow.EXCLUDE:
+            jsonschema["additionalProperties"] = (
+                schema_instance.unknown == marshmallow.INCLUDE
+            )
 
         return jsonschema
 

tests/test_ext_marshmallow_openapi.py

@@ -1,3 +1,4 @@
+import importlib.metadata
 from datetime import datetime
 
 import pytest
@@ -10,6 +11,8 @@
 from .schemas import CustomList, CustomStringField
 from .utils import build_ref, get_schemas, validate_spec
 
+MA_VERSION = Version(importlib.metadata.version("marshmallow"))
+
 
 class TestMarshmallowFieldToOpenAPI:
     def test_fields_with_load_default_load(self, openapi):
@@ -133,6 +136,13 @@ class Meta:
         res = openapi.schema2jsonschema(WhiteStripesSchema)
         assert set(res["properties"].keys()) == {"guitarist", "drummer"}
 
+    def test_unknown_values_default_disallow(self, openapi):
+        class UnknownDefaultSchema(Schema):
+            first = fields.Str()
+
+        res = openapi.schema2jsonschema(UnknownDefaultSchema)
+        assert res["additionalProperties"] is False
+
     def test_unknown_values_disallow(self, openapi):
         class UnknownRaiseSchema(Schema):
             class Meta:
@@ -163,6 +173,30 @@ class Meta:
         res = openapi.schema2jsonschema(UnknownExcludeSchema)
         assert "additionalProperties" not in res
 
+    @pytest.mark.parametrize("meta_unknown", (RAISE, INCLUDE, EXCLUDE, None))
+    @pytest.mark.parametrize(
+        "instance_unknown,expected", ((RAISE, False), (INCLUDE, True), (EXCLUDE, None))
+    )
+    def test_unknown_values_instance_override_meta(
+        self, openapi, instance_unknown, expected, meta_unknown
+    ):
+        class UnknownSchema(Schema):
+            if meta_unknown is not None:
+
+                class Meta:
+                    unknown = meta_unknown
+
+            first = fields.Str()
+
+        res = openapi.schema2jsonschema(UnknownSchema(unknown=instance_unknown))
+        if expected is None:
+            assert "additionalProperties" not in res
+        else:
+            assert res["additionalProperties"] is expected
+
+    @pytest.mark.skipif(
+        MA_VERSION.major >= 4, reason="marshmallow 4 drop inferred fields"
+    )
     def test_only_explicitly_declared_fields_are_translated(self, openapi):
         class UserSchema(Schema):
             _id = fields.Int()