Merge pull request #941 from t-woerner/fix_location_docs_for_ansible_test

ipalocation: Fix documentation sections and agument spec
This commit is contained in:
Rafael Guterres Jeffman
2022-09-30 23:43:22 -03:00
committed by GitHub

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,16 +39,22 @@ extends_documentation_fragment:
options: options:
name: name:
description: The list of location name strings. description: The list of location name strings.
type: list
elements: str
required: true required: true
aliases: ["idnsname"] aliases: ["idnsname"]
description: description:
description: The IPA location string description: The IPA location string
type: str
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 = """
@@ -94,8 +100,8 @@ def gen_args(description):
def main(): def main():
ansible_module = IPAAnsibleModule( ansible_module = IPAAnsibleModule(
argument_spec=dict( argument_spec=dict(
name=dict(type="list", aliases=["idnsname"], name=dict(type="list", elements="str", aliases=["idnsname"],
default=None, required=True), required=True),
# present # present
description=dict(required=False, type='str', default=None), description=dict(required=False, type='str', default=None),
# state # state