ipaservicedelegationrule: Fix documentation sections and agument spec

ansible-test with ansible-2.14 is adding a lot of new tests to ensure
that the documentation section and the agument spec is complete. Needed
changes:

DOCUMENTATION section

- `type: str` needs to be set for string parameters
- `type: list` needs to be set for list parameters
- `elements: str` needs to be given for list of string parameters
- `required` tags need to be fixed according to the `argument_spec`
- `author` needs to be given with the github user also: `Name (@user)`

argument_spec

- `elements="str"` needs to be added to all list of string parameters

The `copyright` date is extended with `-2022`.
This commit is contained in:
Thomas Woerner
2022-09-30 18:02:28 +02:00
parent 07c8bb1efb
commit f64663519e

View File

@@ -40,6 +40,8 @@ extends_documentation_fragment:
options: options:
name: name:
description: The list of servicedelegationrule name strings. description: The list of servicedelegationrule name strings.
type: list
elements: str
required: true required: true
aliases: ["cn"] aliases: ["cn"]
principal: principal:
@@ -49,22 +51,30 @@ options:
host/fqdn@REALM, alias$, alias$@REALM, where fqdn and fqdn@REALM host/fqdn@REALM, alias$, alias$@REALM, where fqdn and fqdn@REALM
are host principals and the same as host/fqdn and host/fqd are host principals and the same as host/fqdn and host/fqd
Host princpals are only usable with IPA versions 4.9.0 and up. Host princpals are only usable with IPA versions 4.9.0 and up.
type: list
elements: str
required: false required: false
target: target:
description: | description: |
The list of service delegation targets. The list of service delegation targets.
type: list
elements: str
required: false required: false
aliases: ["servicedelegationtarget"] aliases: ["servicedelegationtarget"]
action: action:
description: Work on servicedelegationrule or member level. description: Work on servicedelegationrule or member level.
type: str
choices: ["servicedelegationrule", "member"] choices: ["servicedelegationrule", "member"]
default: servicedelegationrule default: servicedelegationrule
required: false required: false
state: state:
description: The state to ensure. description: The state to ensure.
type: str
choices: ["present", "absent"] choices: ["present", "absent"]
default: present default: present
required: true required: false
author:
- Thomas Woerner (@t-woerner)
""" """
EXAMPLES = """ EXAMPLES = """
@@ -161,11 +171,12 @@ def main():
ansible_module = IPAAnsibleModule( ansible_module = IPAAnsibleModule(
argument_spec=dict( argument_spec=dict(
# general # general
name=dict(type="list", aliases=["cn"], default=None, name=dict(type="list", elements="str", aliases=["cn"],
required=True), required=True),
# present # present
principal=dict(required=False, type='list', default=None), principal=dict(required=False, type='list', elements="str",
target=dict(required=False, type='list', default=None),
target=dict(required=False, type='list', elements="str",
aliases=["servicedelegationtarget"], default=None), aliases=["servicedelegationtarget"], default=None),
action=dict(type="str", default="servicedelegationrule", action=dict(type="str", default="servicedelegationrule",