From 65732f33c19f2fa999fda45eae127a5bf618b30d Mon Sep 17 00:00:00 2001
From: Thomas Woerner <twoerner@redhat.com>
Date: Fri, 30 Sep 2022 15:41:16 +0200
Subject: [PATCH] ipalocation: 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
- `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/ipalocation.py | 14 ++++++++++----
1 file changed, 10 insertions(+), 4 deletions(-)
diff --git a/plugins/modules/ipalocation.py b/plugins/modules/ipalocation.py
index 7a42b05c..d941658c 100644
--- a/plugins/modules/ipalocation.py
+++ b/plugins/modules/ipalocation.py
@@ -3,7 +3,7 @@
# Authors:
# Thomas Woerner <twoerner@redhat.com>
#
-# Copyright (C) 2020 Red Hat
+# Copyright (C) 2020-2022 Red Hat
# see file 'COPYING' for use and warranty information
#
# This program is free software; you can redistribute it and/or modify
@@ -39,16 +39,22 @@ extends_documentation_fragment:
options:
name:
description: The list of location name strings.
+ type: list
+ elements: str
required: true
aliases: ["idnsname"]
description:
description: The IPA location string
+ type: str
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 = """
@@ -94,8 +100,8 @@ def gen_args(description):
def main():
ansible_module = IPAAnsibleModule(
argument_spec=dict(
- name=dict(type="list", aliases=["idnsname"],
- default=None, required=True),
+ name=dict(type="list", elements="str", aliases=["idnsname"],
+ required=True),
# present
description=dict(required=False, type='str', default=None),
# state
--
GitLab