openstack
/
nova
Code Issues Proposed changes

Add missing information to docstring 

A recent change to the '_soft_validate_additional_properties()' method
in nova/api/validation/validators.py added new behaviors without
updating the docstring to reflect the new behaviors. Rather than block
that patch from merging, it was felt that a follow-up patch to fix the
docstring was preferable.

Closes-bug: 1494289
Change-Id: I3e32742a935b94eb211591bbf1e5695d5301101e
This commit is contained in:
EdLeafe 2015-09-10 14:46:48 +00:00
parent b519516cad
commit eadcdccd74
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
nova/api/validation/validators.py
View File

@ -87,6 +87,10 @@ def _soft_validate_additional_properties(validator,
the schema, this will return without any effect. If there are any such the schema, this will return without any effect. If there are any such
extra properties, they will be handled as follows: extra properties, they will be handled as follows:
- if the validator passed to the method is not of type "object", this
method will return without any effect.
- if the 'additional_properties_value' parameter is True, this method will
return without any effect.
- if the schema has an additionalProperties value of True, the extra - if the schema has an additionalProperties value of True, the extra
properties on the instance will not be touched. properties on the instance will not be touched.
- if the schema has an additionalProperties value of False and there - if the schema has an additionalProperties value of False and there