From 40dc47ec7224baf1f40c2a8c6fec6cabc4010c60 Mon Sep 17 00:00:00 2001
From: Thomas Woerner <twoerner@redhat.com>
Date: Fri, 30 Sep 2022 17:56:33 +0200
Subject: [PATCH] ipaserver: 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/ipaserver.py | 14 ++++++++++----
1 file changed, 10 insertions(+), 4 deletions(-)
diff --git a/plugins/modules/ipaserver.py b/plugins/modules/ipaserver.py
index 01546e9c..2d503666 100644
--- a/plugins/modules/ipaserver.py
+++ b/plugins/modules/ipaserver.py
@@ -3,7 +3,7 @@
# Authors:
# Thomas Woerner <twoerner@redhat.com>
#
-# Copyright (C) 2021 Red Hat
+# Copyright (C) 2021-2022 Red Hat
# see file 'COPYING' for use and warranty information
#
# This program is free software; you can redistribute it and/or modify
@@ -39,6 +39,8 @@ extends_documentation_fragment:
options:
name:
description: The list of server name strings.
+ type: list
+ elements: str
required: true
aliases: ["cn"]
location:
@@ -46,6 +48,7 @@ options:
The server location string.
"" for location reset.
Only in state: present.
+ type: str
required: false
aliases: ["ipalocation_location"]
service_weight:
@@ -96,9 +99,12 @@ options:
type: bool
state:
description: The state to ensure.
+ type: str
choices: ["present", "absent"]
default: present
- required: true
+ required: false
+author:
+ - Thomas Woerner (@t-woerner)
"""
EXAMPLES = """
@@ -244,8 +250,8 @@ def main():
ansible_module = IPAAnsibleModule(
argument_spec=dict(
# general
- name=dict(type="list", aliases=["cn"],
- default=None, required=True),
+ name=dict(type="list", elements="str", aliases=["cn"],
+ required=True),
# present
location=dict(required=False, type='str',
aliases=["ipalocation_location"], default=None),
--
GitLab