ipadelegation: : 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`
- `authors` 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 14:21:27 +02:00
parent 07c8bb1efb
commit daa007c0d5

View File

@@ -3,7 +3,7 @@
# Authors: # Authors:
# Thomas Woerner <twoerner@redhat.com> # Thomas Woerner <twoerner@redhat.com>
# #
# Copyright (C) 2020 Red Hat # Copyright (C) 2020-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,33 +39,45 @@ extends_documentation_fragment:
options: options:
name: name:
description: The list of delegation name strings. description: The list of delegation name strings.
type: list
elements: str
required: true required: true
aliases: ["aciname"] aliases: ["aciname"]
permission: permission:
description: Permissions to grant (read, write). Default is write. description: Permissions to grant (read, write). Default is write.
type: list
elements: str
required: false required: false
aliases: ["permissions"] aliases: ["permissions"]
attribute: attribute:
description: Attribute list to which the delegation applies description: Attribute list to which the delegation applies
type: list
elements: str
required: false required: false
aliases: ["attrs"] aliases: ["attrs"]
membergroup: membergroup:
description: User group to apply delegation to description: User group to apply delegation to
type: str
required: false required: false
aliases: ["memberof"] aliases: ["memberof"]
group: group:
description: User group ACI grants access to description: User group ACI grants access to
type: str
required: false required: false
action: action:
description: Work on delegation or member level. description: Work on delegation or member level.
type: str
choices: ["delegation", "member"] choices: ["delegation", "member"]
default: delegation default: delegation
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 = """
@@ -143,13 +155,13 @@ def main():
ansible_module = IPAAnsibleModule( ansible_module = IPAAnsibleModule(
argument_spec=dict( argument_spec=dict(
# general # general
name=dict(type="list", aliases=["aciname"], default=None, name=dict(type="list", elements="str", aliases=["aciname"],
required=True), required=True),
# present # present
permission=dict(required=False, type='list', permission=dict(required=False, type='list', elements="str",
aliases=["permissions"], default=None), aliases=["permissions"], default=None),
attribute=dict(required=False, type='list', aliases=["attrs"], attribute=dict(required=False, type='list', elements="str",
default=None), aliases=["attrs"], default=None),
membergroup=dict(type="str", aliases=["memberof"], default=None), membergroup=dict(type="str", aliases=["memberof"], default=None),
group=dict(type="str", default=None), group=dict(type="str", default=None),
action=dict(type="str", default="delegation", action=dict(type="str", default="delegation",