Skip to content

Commit 6138918

Browse files
committed
Document role entrypoint attributes.
1 parent c7c3eea commit 6138918

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

docs/docsite/rst/playbook_guide/playbooks_reuse_roles.rst

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -404,6 +404,44 @@ role ``meta/argument_specs.yml`` file. All fields are lowercase.
404404

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

407+
:attributes:
408+
409+
* A dictionary mapping attribute names to dictionaries describing that attribute.
410+
411+
:description:
412+
413+
* A string or a list of strings. Each string is one paragraph. The description is required.
414+
* Explanation of what this attribute does. It should be written in full sentences.
415+
416+
:details:
417+
418+
* A string or a list of strings. Each string is one paragraph.
419+
* Describes how support might not work as expected by the user.
420+
* The details are optional in general, but must be provided if ``support`` is ``partial``.
421+
422+
:support:
423+
424+
* One of ``full``, ``none``, ``partial``, or ``N/A``. This is required.
425+
* Indicates whether this attribute is supported by this role entrypoint.
426+
427+
:membership:
428+
429+
* A string or a list of strings.
430+
* Must only be used for the attribute ``action_group``, and must always be specified for that attribute.
431+
* Lists the action groups this role entrypoint supports.
432+
433+
:platforms:
434+
435+
* A string or a list of strings.
436+
* Must only be used for the attribute ``platform``, and must always be specified for that attribute.
437+
* Lists the platforms this role entrypoint supports.
438+
439+
:version_added:
440+
441+
* 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.
442+
* This is a string, and not a float, for example, ``version_added: '2.3'``.
443+
* 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``.
444+
407445
Sample specification
408446
--------------------
409447

0 commit comments

Comments
 (0)