Skip to content

disable required properties checks in allOf blocks #28

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.

Sign up for GitHub

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 1 commit into from
Jun 21, 2018
Merged

disable required properties checks in allOf blocks #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 6 additions & 3 deletions openapi_spec_validator/validators.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,18 +111,21 @@ class SchemaValidator(object):
def __init__(self, dereferencer):
self.dereferencer = dereferencer

def iter_errors(self, schema):
def iter_errors(self, schema, require_properties=True):
schema_deref = self.dereferencer.dereference(schema)

if 'allOf' in schema_deref:
for inner_schema in schema_deref['allOf']:
for err in self.iter_errors(inner_schema):
for err in self.iter_errors(
inner_schema,
require_properties=False
):
yield err

required = schema_deref.get('required', [])
properties = schema_deref.get('properties', {}).keys()
extra_properties = list(set(required) - set(properties))
if extra_properties:
if extra_properties and require_properties:
yield ExtraParametersError(
"Required list has not defined properties: {0}".format(
extra_properties
Expand Down
34 changes: 34 additions & 0 deletions tests/integration/test_validators.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,40 @@ def test_same_parameters_names(self, validator):
errors_list = list(errors)
assert errors_list == []

def test_allow_allof_required_no_properties(self, validator):
spec = {
'openapi': '3.0.0',
'info': {
'title': 'Test Api',
'version': '0.0.1',
},
'paths': {},
'components': {
'schemas': {
'Credit': {
'type': 'object',
'properties': {
'clientId': {'type': 'string'},
}
},
'CreditCreate': {
'allOf': [
{
'$ref': '#/components/schemas/Credit'
},
{
'required': ['clientId']
}
]
}
},
},
}

errors = validator.iter_errors(spec)
errors_list = list(errors)
assert errors_list == []

def test_extra_parameters_in_required(self, validator):
spec = {
'openapi': '3.0.0',
Expand Down