You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/docsite/rst/playbook_guide/playbooks_reuse_roles.rst
+38
Original file line number
Diff line number
Diff line change
@@ -365,6 +365,44 @@ role ``meta/argument_specs.yml`` file. All fields are lowercase.
365
365
366
366
* If this option takes a dict or list of dicts, you can define the structure here.
367
367
368
+
:attributes:
369
+
370
+
* A dictionary mapping attribute names to dictionaries describing that attribute.
371
+
372
+
:description:
373
+
374
+
* A string or a list of strings. Each string is one paragraph. The description is required.
375
+
* Explanation of what this attribute does. It should be written in full sentences.
376
+
377
+
:details:
378
+
379
+
* A string or a list of strings. Each string is one paragraph.
380
+
* Describes how support might not work as expected by the user.
381
+
* The details are optional in general, but must be provided if ``support`` is ``partial``.
382
+
383
+
:support:
384
+
385
+
* One of ``full``, ``none``, ``partial``, or ``N/A``. This is required.
386
+
* Indicates whether this attribute is supported by this role entrypoint.
387
+
388
+
:membership:
389
+
390
+
* A string or a list of strings.
391
+
* Must only be used for the attribute ``action_group``, and must always be specified for that attribute.
392
+
* Lists the action groups this role entrypoint supports.
393
+
394
+
:platforms:
395
+
396
+
* A string or a list of strings.
397
+
* Must only be used for the attribute ``platform``, and must always be specified for that attribute.
398
+
* Lists the platforms this role entrypoint supports.
399
+
400
+
:version_added:
401
+
402
+
* 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.
403
+
* This is a string, and not a float, for example, ``version_added: '2.3'``.
404
+
* 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``.
0 commit comments