Skip to content
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.

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

[WIP] Document role entrypoint attributes #1212

Draft
wants to merge 1 commit into
base: devel
Choose a base branch
from
Draft
Changes from all commits
Commits
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
38 changes: 38 additions & 0 deletions docs/docsite/rst/playbook_guide/playbooks_reuse_roles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -365,6 +365,44 @@ role ``meta/argument_specs.yml`` file. All fields are lowercase.

* If this option takes a dict or list of dicts, you can define the structure here.

:attributes:

* A dictionary mapping attribute names to dictionaries describing that attribute.

:description:

* A string or a list of strings. Each string is one paragraph. The description is required.
* Explanation of what this attribute does. It should be written in full sentences.

:details:

* A string or a list of strings. Each string is one paragraph.
* Describes how support might not work as expected by the user.
* The details are optional in general, but must be provided if ``support`` is ``partial``.

:support:

* One of ``full``, ``none``, ``partial``, or ``N/A``. This is required.
* Indicates whether this attribute is supported by this role entrypoint.

:membership:

* A string or a list of strings.
* Must only be used for the attribute ``action_group``, and must always be specified for that attribute.
* Lists the action groups this role entrypoint supports.

:platforms:

* A string or a list of strings.
* Must only be used for the attribute ``platform``, and must always be specified for that attribute.
* Lists the platforms this role entrypoint supports.

:version_added:

* Only needed if this attribute's support was extended after the role entrypoint was created, in other words, this is greater than the entrypoint's top level ``version_added`` field.
* This is a string, and not a float, for example, ``version_added: '2.3'``.
* In collections, this must be the collection version the attribute's support was added to, not the Ansible version. For example, ``version_added: 1.0.0``.

Sample specification
--------------------

Expand Down