Skip to content

Object additionalProperties support #121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 22, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions openapi_core/schema/schemas/factories.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ def create(self, schema_spec):
deprecated = schema_deref.get('deprecated', False)
all_of_spec = schema_deref.get('allOf', None)
one_of_spec = schema_deref.get('oneOf', None)
additional_properties_spec = schema_deref.get('additionalProperties')
additional_properties_spec = schema_deref.get('additionalProperties',
True)
min_items = schema_deref.get('minItems', None)
max_items = schema_deref.get('maxItems', None)
min_length = schema_deref.get('minLength', None)
Expand Down Expand Up @@ -59,8 +60,8 @@ def create(self, schema_spec):
if items_spec:
items = self._create_items(items_spec)

additional_properties = None
if additional_properties_spec:
additional_properties = additional_properties_spec
if isinstance(additional_properties_spec, dict):
additional_properties = self.create(additional_properties_spec)

return Schema(
Expand Down
24 changes: 13 additions & 11 deletions openapi_core/schema/schemas/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ def __init__(
self, schema_type=None, model=None, properties=None, items=None,
schema_format=None, required=None, default=None, nullable=False,
enum=None, deprecated=False, all_of=None, one_of=None,
additional_properties=None, min_items=None, max_items=None,
additional_properties=True, min_items=None, max_items=None,
min_length=None, max_length=None, pattern=None, unique_items=False,
minimum=None, maximum=None, multiple_of=None,
exclusive_minimum=False, exclusive_maximum=False,
Expand Down Expand Up @@ -284,14 +284,15 @@ def _unmarshal_properties(self, value, one_of_schema=None,

value_props_names = value.keys()
extra_props = set(value_props_names) - set(all_props_names)
if extra_props and self.additional_properties is None:
if extra_props and self.additional_properties is False:
raise UndefinedSchemaProperty(extra_props)

properties = {}
for prop_name in extra_props:
prop_value = value[prop_name]
properties[prop_name] = self.additional_properties.unmarshal(
prop_value, custom_formatters=custom_formatters)
if self.additional_properties is not True:
for prop_name in extra_props:
prop_value = value[prop_name]
properties[prop_name] = self.additional_properties.unmarshal(
prop_value, custom_formatters=custom_formatters)

for prop_name, prop in iteritems(all_props):
try:
Expand Down Expand Up @@ -515,13 +516,14 @@ def _validate_properties(self, value, one_of_schema=None,

value_props_names = value.keys()
extra_props = set(value_props_names) - set(all_props_names)
if extra_props and self.additional_properties is None:
if extra_props and self.additional_properties is False:
raise UndefinedSchemaProperty(extra_props)

for prop_name in extra_props:
prop_value = value[prop_name]
self.additional_properties.validate(
prop_value, custom_formatters=custom_formatters)
if self.additional_properties is not True:
for prop_name in extra_props:
prop_value = value[prop_name]
self.additional_properties.validate(
prop_value, custom_formatters=custom_formatters)

for prop_name, prop in iteritems(all_props):
try:
Expand Down
1 change: 1 addition & 0 deletions tests/integration/data/v3.0/petstore.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -295,6 +295,7 @@ components:
$ref: "#/components/schemas/Utctime"
name:
type: string
additionalProperties: false
TagList:
type: array
items:
Expand Down
21 changes: 21 additions & 0 deletions tests/unit/schema/test_schemas.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
from openapi_core.extensions.models.models import Model
from openapi_core.schema.schemas.exceptions import (
InvalidSchemaValue, MultipleOneOfSchema, NoOneOfSchema, OpenAPISchemaError,
UndefinedSchemaProperty
)
from openapi_core.schema.schemas.models import Schema

Expand Down Expand Up @@ -697,6 +698,26 @@ def test_object_max_properties(self, value):

assert result == value

@pytest.mark.parametrize('value', [Model({'additional': 1}), ])
def test_object_additional_propetries(self, value):
schema = Schema('object')

schema.validate(value)

@pytest.mark.parametrize('value', [Model({'additional': 1}), ])
def test_object_additional_propetries_false(self, value):
schema = Schema('object', additional_properties=False)

with pytest.raises(UndefinedSchemaProperty):
schema.validate(value)

@pytest.mark.parametrize('value', [Model({'additional': 1}), ])
def test_object_additional_propetries_object(self, value):
additional_properties = Schema('integer')
schema = Schema('object', additional_properties=additional_properties)

schema.validate(value)

@pytest.mark.parametrize('value', [[], ])
def test_list_min_items_invalid_schema(self, value):
schema = Schema(
Expand Down