role argument spec: allow for shared fragments, like with plugins

[evgeni]

Summary

When writing documentation for plugins, one can use doc_fragments to have a library of common things to document.
For the AnsibleModule.argument_spec people usually use Pythons inheritance (or helpers like url_argument_spec).

When it comes to role argument specs, there is no comparable feature.
When documenting multiple entrypoints in one role, I've seen people using YAML anchors (&/*) to reference the same blocks, but this doesn't work when documenting multiple roles in a collection that share the same "base" parameters (credentials, for example).

It would be cool if we Ansible would have a place (collection_root/meta/role_argument_specs.yml?) that can define a common base that can be referenced later.

Issue Type

Feature Idea

Component Name

role

Additional Information

Code of Conduct

• I agree to follow the Ansible Code of Conduct

[ansibot]

Files identified in the description:

• lib/ansible/playbook/role

If these files are incorrect, please update the component name section of the description or use the !component bot command.

click here for bot help