ipaautomountlocation: 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
- `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
- `default=.*` needs to be dropped if `required=True` is also given

The `copyright` date is extended with `-2022`.
This commit is contained in:
Thomas Woerner
2022-09-30 14:03:40 +02:00
parent 07c8bb1efb
commit e7e6572e02

View File

@@ -1,8 +1,9 @@
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
# Authors: # Authors:
# Chris Procter <cprocter@redhat.com> # Chris Procter <cprocter@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
@@ -32,7 +33,9 @@ ANSIBLE_METADATA = {
DOCUMENTATION = ''' DOCUMENTATION = '''
--- ---
module: ipaautomountlocation module: ipaautomountlocation
author: chris procter author:
- Chris Procter (@chr15p)
- Thomas Woerner (@t-woerner)
short_description: Manage FreeIPA autommount locations short_description: Manage FreeIPA autommount locations
description: description:
- Add and delete an IPA automount location - Add and delete an IPA automount location
@@ -42,10 +45,13 @@ options:
name: name:
description: The automount location to be managed description: The automount location to be managed
required: true required: true
type: list
elements: str
aliases: ["cn","location"] aliases: ["cn","location"]
state: state:
description: State to ensure description: State to ensure
required: false required: false
type: str
default: present default: present
choices: ["present", "absent"] choices: ["present", "absent"]
''' '''
@@ -116,9 +122,8 @@ def main():
default='present', default='present',
choices=['present', 'absent'] choices=['present', 'absent']
), ),
name=dict(type="list", name=dict(type="list", elements="str",
aliases=["cn", "location"], aliases=["cn", "location"],
default=None,
required=True required=True
), ),
), ),