validate-modules: support plugin see-also (#80244)

pull/80284/head
Felix Fontein 2 years ago committed by GitHub
parent 6a6824f570
commit 5388f6020a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -0,0 +1,2 @@
minor_changes:
- "validate-modules sanity test - support the ``plugin`` see-also part of the semantic markup specification (https://github.com/ansible/ansible/pull/80244)."

@ -17,6 +17,9 @@ DOCUMENTATION:
default: foo default: foo
author: author:
- Ansible Core Team - Ansible Core Team
seealso:
- plugin: ns.col.import_order_lookup
plugin_type: lookup
EXAMPLES: | EXAMPLES: |
- name: example for sidecar - name: example for sidecar

@ -12,6 +12,7 @@ from functools import partial
from urllib.parse import urlparse from urllib.parse import urlparse
from voluptuous import ALLOW_EXTRA, PREVENT_EXTRA, All, Any, Invalid, Length, Required, Schema, Self, ValueInvalid, Exclusive from voluptuous import ALLOW_EXTRA, PREVENT_EXTRA, All, Any, Invalid, Length, Required, Schema, Self, ValueInvalid, Exclusive
from ansible.constants import DOCUMENTABLE_PLUGINS
from ansible.module_utils.six import string_types from ansible.module_utils.six import string_types
from ansible.module_utils.common.collections import is_iterable from ansible.module_utils.common.collections import is_iterable
from ansible.module_utils.parsing.convert_bool import boolean from ansible.module_utils.parsing.convert_bool import boolean
@ -172,6 +173,11 @@ seealso_schema = Schema(
Required('module'): Any(*string_types), Required('module'): Any(*string_types),
'description': doc_string, 'description': doc_string,
}, },
{
Required('plugin'): Any(*string_types),
Required('plugin_type'): Any(*DOCUMENTABLE_PLUGINS),
'description': doc_string,
},
{ {
Required('ref'): Any(*string_types), Required('ref'): Any(*string_types),
Required('description'): doc_string, Required('description'): doc_string,

Loading…
Cancel
Save