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

ipaprivilege: 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
...@@ -2,8 +2,9 @@ ...@@ -2,8 +2,9 @@
# Authors: # Authors:
# Rafael Guterres Jeffman <rjeffman@redhat.com> # Rafael Guterres Jeffman <rjeffman@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
...@@ -42,28 +43,39 @@ extends_documentation_fragment: ...@@ -42,28 +43,39 @@ extends_documentation_fragment:
options: options:
name: name:
description: The list of privilege name strings. description: The list of privilege name strings.
type: list
elements: str
required: true required: true
aliases: ["cn"] aliases: ["cn"]
description: description:
description: Privilege description description: Privilege description
type: str
required: false required: false
rename: rename:
description: Rename the privilege object. description: Rename the privilege object.
type: str
required: false required: false
aliases: ["new_name"] aliases: ["new_name"]
permission: permission:
description: Permissions to be added to the privilege. description: Permissions to be added to the privilege.
type: list
elements: str
required: false required: false
action: action:
description: Work on privilege or member level. description: Work on privilege or member level.
type: str
choices: ["privilege", "member"] choices: ["privilege", "member"]
default: privilege default: privilege
required: false required: false
state: state:
description: The state to ensure. description: The state to ensure.
type: str
choices: ["present", "absent", "renamed"] choices: ["present", "absent", "renamed"]
default: present default: present
required: true required: false
author:
- Rafael Guterres Jeffman (@rjeffman)
- Thomas Woerner (@t-woerner)
""" """
EXAMPLES = """ EXAMPLES = """
...@@ -134,13 +146,14 @@ def main(): ...@@ -134,13 +146,14 @@ 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
description=dict(required=False, type='str', default=None), description=dict(required=False, type='str', default=None),
rename=dict(required=False, type='str', default=None, rename=dict(required=False, type='str', default=None,
aliases=["new_name"], ), aliases=["new_name"], ),
permission=dict(required=False, type='list', default=None), permission=dict(required=False, type='list', elements="str",
default=None),
action=dict(type="str", default="privilege", action=dict(type="str", default="privilege",
choices=["member", "privilege"]), choices=["member", "privilege"]),
# state # state
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment