Support for additionalProperties

.gitignore

@@ -6,3 +6,4 @@ openapi3.egg-info/*
 build/*
 dist/*
 .idea
+/.eggs/

openapi3/schemas.py

@@ -131,7 +131,7 @@ def get_type(self):
  self._model_type = type(
  type_name,
  (Model,),
- {"__slots__": self.properties.keys()}, # pylint: disable=attribute-defined-outside-init
+ ({} if self.additionalProperties else {"__slots__": self.properties.keys()}), # pylint: disable=attribute-defined-outside-init
  )
 
  return self._model_type
@@ -278,14 +278,16 @@ def __init__(self, data, schema):
  setattr(self, s, None)
 
  keys = set(data.keys()) - frozenset(self.__slots__)
- if keys:
+ if keys and not schema.additionalProperties:
  raise ModelError("Schema {} got unexpected attribute keys {}".format(self.__class__.__name__, keys))
 
  # collect the data into this model
  for k, v in data.items():
- prop = schema.properties[k]
+ prop = schema.properties.get(k) if schema.properties else None
 
- if prop.type == "array":
+ if (not prop) and schema.additionalProperties:
+ setattr(self, k, v)
+ elif prop.type == "array":
  # handle arrays
  item_schema = prop.items
  setattr(self, k, [item_schema.model(c) for c in v])

tests/additional_properties_test.py

@@ -0,0 +1,15 @@
+import pytest
+
+from unittest.mock import patch, MagicMock
+
+
+def test_additional_properties(additional_properties_spec):
+ resp = MagicMock(status_code=200, headers={"Content-Type": "application/json"}, json=lambda: {"foo": "bar", "additional": "property"})
+ with patch("requests.sessions.Session.send", return_value=resp) as s:
+ additional_properties_spec.call_test_operation1()
+
+
+def test_only_additional_properties(additional_properties_spec):
+ resp = MagicMock(status_code=200, headers={"Content-Type": "application/json"}, json=lambda: {"additional": "property"})
+ with patch("requests.sessions.Session.send", return_value=resp) as s:
+ additional_properties_spec.call_test_operation2()

tests/conftest.py

@@ -161,3 +161,10 @@ def with_ref_allof():
  an allOf
  """
  yield _get_parsed_yaml("ref-allof.yaml")
+
+@pytest.fixture
+def additional_properties_spec():
+ """
+ Provides an OpenAPI version of the additional-properties.yaml spec
+ """
+ yield _get_parsed_spec("additional-properties.yaml")

tests/fixtures/additional-properties.yaml

@@ -0,0 +1,34 @@
+openapi: "3.0.0"
+info:
+ version: 1.0.0
+ title: This uses additionalProperties
+servers:
+ - url: http://test.example/api
+paths:
+ /additional_prop:
+ get:
+ operationId: test_operation1
+ responses:
+ "200":
+ description: Success!
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ foo:
+ type: string
+ additionalProperties:
+ type: string
+ /only_additional_prop2:
+ get:
+ operationId: test_operation2
+ responses:
+ "200":
+ description: Success!
+ content:
+ application/json:
+ schema:
+ type: object
+ additionalProperties:
+ type: string