Merge pull request #955 from t-woerner/fix_ipatopologysuffix_docs_for_ansible_test

ipatopologysuffix: Fix documentation sections and agument spec
This commit is contained in:
Rafael Guterres Jeffman
2022-10-04 15:10:12 -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) 2019 Red Hat # Copyright (C) 2019-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,14 +39,16 @@ extends_documentation_fragment:
options: options:
suffix: suffix:
description: Topology suffix description: Topology suffix
type: str
required: true required: true
choices: ["domain", "ca"] choices: ["domain", "ca"]
state: state:
description: State to ensure description: State to ensure
type: str
default: verified default: verified
choices: ["verified"] choices: ["verified"]
author: author:
- Thomas Woerner - Thomas Woerner (@t-woerner)
""" """
EXAMPLES = """ EXAMPLES = """
@@ -65,7 +67,7 @@ from ansible.module_utils.ansible_freeipa_module import IPAAnsibleModule
def main(): def main():
ansible_module = IPAAnsibleModule( ansible_module = IPAAnsibleModule(
argument_spec=dict( argument_spec=dict(
suffix=dict(choices=["domain", "ca"], required=True), suffix=dict(type="str", choices=["domain", "ca"], required=True),
state=dict(type="str", default="verified", state=dict(type="str", default="verified",
choices=["verified"]), choices=["verified"]),
), ),