Skip to content
Snippets Groups Projects
Commit 40dc47ec authored by Thomas Woerner's avatar Thomas Woerner
Browse files

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`.
parent 07c8bb1e
No related branches found
No related tags found
No related merge requests found
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
# Authors: # Authors:
# Thomas Woerner <twoerner@redhat.com> # Thomas Woerner <twoerner@redhat.com>
# #
# Copyright (C) 2021 Red Hat # Copyright (C) 2021-2022 Red Hat
# see file 'COPYING' for use and warranty information # see file 'COPYING' for use and warranty information
# #
# This program is free software; you can redistribute it and/or modify # This program is free software; you can redistribute it and/or modify
...@@ -39,6 +39,8 @@ extends_documentation_fragment: ...@@ -39,6 +39,8 @@ extends_documentation_fragment:
options: options:
name: name:
description: The list of server name strings. description: The list of server name strings.
type: list
elements: str
required: true required: true
aliases: ["cn"] aliases: ["cn"]
location: location:
...@@ -46,6 +48,7 @@ options: ...@@ -46,6 +48,7 @@ options:
The server location string. The server location string.
"" for location reset. "" for location reset.
Only in state: present. Only in state: present.
type: str
required: false required: false
aliases: ["ipalocation_location"] aliases: ["ipalocation_location"]
service_weight: service_weight:
...@@ -96,9 +99,12 @@ options: ...@@ -96,9 +99,12 @@ options:
type: bool type: bool
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 = """
...@@ -244,8 +250,8 @@ def main(): ...@@ -244,8 +250,8 @@ def main():
ansible_module = IPAAnsibleModule( ansible_module = IPAAnsibleModule(
argument_spec=dict( argument_spec=dict(
# general # general
name=dict(type="list", aliases=["cn"], name=dict(type="list", elements="str", aliases=["cn"],
default=None, required=True), required=True),
# present # present
location=dict(required=False, type='str', location=dict(required=False, type='str',
aliases=["ipalocation_location"], default=None), aliases=["ipalocation_location"], default=None),
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment