Support recursive suboptions schema

[sivel]

SUMMARY

argument_spec allows "recursive" options, the documentation should allow recursive suboptions.

This requires voluptuous>=0.11.0

See #37196

ISSUE TYPE

• Bugfix Pull Request

COMPONENT NAME

test/sanity/validate-modules/schema.py

ANSIBLE VERSION

devel

ADDITIONAL INFORMATION

Before:

ansible/lib/ansible/modules/network/fortios/fortios_webfilter.py:0:0: E305 DOCUMENTATION.options.webfilter_url.suboptions.entries.suboptions: extra keys not allowed @ data['options']['webfilter_url']['suboptions']['entries']['suboptions']. Got {'id': {'description': ['Id of URL.'], 'required': True, 'type': 'integer'}, 'url': {'description': ['URL to be filtered.'], 'required': True}, 'type': {'description': ['Filter type (simple, regex, or wildcard).'], 'required': True, 'choices': ['simple', 'regex', 'wildcard']}, 'action': {'description': ['Action to take for URL filter matches.'], 'required': True, 'choices': ['exempt', 'block', 'allow', 'monitor']}, 'status': {'description': ['Enable/disable this URL filter.'], 'required': Tru...
ansible/lib/ansible/modules/network/fortios/fortios_webfilter.py:0:0: E305 DOCUMENTATION.options.webfilter_content.suboptions.entries.suboptions: extra keys not allowed @ data['options']['webfilter_content']['suboptions']['entries']['suboptions']. Got {'name': {'description': ['Banned word.'], 'required': True}, 'pattern-type': {'description': [{'Banned word pattern type': 'wildcard pattern or Perl regular expression.'}], 'required': True, 'choices': ['wildcard', 'regexp']}, 'status': {'description': ['Enable/disable banned word.'], 'required': True, 'choices': ['enable', 'disable']}, 'lang': {'description': ['Language of banned word.'], 'required': True, 'choices': ['western', 'simch', 'trach', 'japanese', 'korean', 'french', 'thai', 'spa...

After:

ansible/lib/ansible/modules/network/fortios/fortios_webfilter.py:0:0: E305 DOCUMENTATION.options.webfilter_url.suboptions.entries.suboptions.id.type: not a valid value for dictionary value @ data['options']['webfilter_url']['suboptions']['entries']['suboptions']['id']['type']. Got 'integer'
ansible/lib/ansible/modules/network/fortios/fortios_webfilter.py:0:0: E305 DOCUMENTATION.options.webfilter_content.suboptions.entries.suboptions.pattern-type.description.0: expected str @ data['options']['webfilter_content']['suboptions']['entries']['suboptions']['pattern-type']['description'][0]. Got {'Banned word pattern type': 'wildcard pattern or Perl regular expression.'}

[ansibot]

cc @mattclay
click here for bot help

[gundalow]

Oh, that was easy :)

[gundalow]

You can remove this line now as this is tracking other todo's

[mattclay]

Please add the version constraint for voluptuous to test/runner/requirements/constraints.txt.

[sivel]

Please add the version constraint for voluptuous to test/runner/requirements/constraints.txt.

Done.