From f64663519e585799354282409e0114ed5f03861d Mon Sep 17 00:00:00 2001
From: Thomas Woerner <twoerner@redhat.com>
Date: Fri, 30 Sep 2022 18:02:28 +0200
Subject: [PATCH] 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`.
---
plugins/modules/ipaservicedelegationrule.py | 19 +++++++++++++++----
1 file changed, 15 insertions(+), 4 deletions(-)
diff --git a/plugins/modules/ipaservicedelegationrule.py b/plugins/modules/ipaservicedelegationrule.py
index aed826ba..35214b05 100644
--- a/plugins/modules/ipaservicedelegationrule.py
+++ b/plugins/modules/ipaservicedelegationrule.py
@@ -40,6 +40,8 @@ extends_documentation_fragment:
options:
name:
description: The list of servicedelegationrule name strings.
+ type: list
+ elements: str
required: true
aliases: ["cn"]
principal:
@@ -49,22 +51,30 @@ options:
host/fqdn@REALM, alias$, alias$@REALM, where fqdn and fqdn@REALM
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.
+ type: list
+ elements: str
required: false
target:
description: |
The list of service delegation targets.
+ type: list
+ elements: str
required: false
aliases: ["servicedelegationtarget"]
action:
description: Work on servicedelegationrule or member level.
+ type: str
choices: ["servicedelegationrule", "member"]
default: servicedelegationrule
required: false
state:
description: The state to ensure.
+ type: str
choices: ["present", "absent"]
default: present
- required: true
+ required: false
+author:
+ - Thomas Woerner (@t-woerner)
"""
EXAMPLES = """
@@ -161,11 +171,12 @@ def main():
ansible_module = IPAAnsibleModule(
argument_spec=dict(
# general
- name=dict(type="list", aliases=["cn"], default=None,
+ name=dict(type="list", elements="str", aliases=["cn"],
required=True),
# present
- principal=dict(required=False, type='list', default=None),
- target=dict(required=False, type='list',
+ principal=dict(required=False, type='list', elements="str",
+ default=None),
+ target=dict(required=False, type='list', elements="str",
aliases=["servicedelegationtarget"], default=None),
action=dict(type="str", default="servicedelegationrule",
--
GitLab