[PR #9388/6aadcc72 backport][stable-10] [mem ... n]*.py: normalize docs (#9406)

[mem ... n]*.py: normalize docs (#9388)

* [mem ... n]*.py: normalize docs

* Update plugins/modules/netcup_dns.py

Co-authored-by: Felix Fontein <felix@fontein.de>

* netcup_dns: change type of RV(records)

From complex to list of dicts.

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit 6aadcc72d1)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
patchback[bot] 2024-12-26 17:06:05 +01:00 committed by GitHub
parent 03f3b74934
commit 7732d64abb
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
25 changed files with 2245 additions and 2342 deletions

View file

@ -8,53 +8,50 @@
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
DOCUMENTATION = '''
---
DOCUMENTATION = r"""
module: memset_zone_domain
author: "Simon Weald (@glitchcrab)"
short_description: Create and delete domains in Memset DNS zones
notes:
- Zone domains can be thought of as a collection of domains, all of which share the
same DNS records (i.e. they point to the same IP). An API key generated via the
Memset customer control panel is needed with the following minimum scope -
C(dns.zone_domain_create), C(dns.zone_domain_delete), C(dns.zone_domain_list).
- Currently this module can only create one domain at a time. Multiple domains should
be created using C(loop).
- Zone domains can be thought of as a collection of domains, all of which share the same DNS records (in other words, they point to the same IP). An API
key generated using the Memset customer control panel is needed with the following minimum scope - C(dns.zone_domain_create), C(dns.zone_domain_delete),
C(dns.zone_domain_list).
- Currently this module can only create one domain at a time. Multiple domains should be created using C(loop).
description:
- Manage DNS zone domains in a Memset account.
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
check_mode:
support: full
diff_mode:
support: none
options:
state:
default: present
description:
- Indicates desired state of resource.
type: str
choices: [ absent, present ]
api_key:
required: true
description:
- The API key obtained from the Memset control panel.
type: str
domain:
required: true
description:
- The zone domain name. Ensure this value has at most 250 characters.
type: str
aliases: ['name']
zone:
required: true
description:
- The zone to add the domain to (this must already exist).
type: str
'''
state:
default: present
description:
- Indicates desired state of resource.
type: str
choices: [absent, present]
api_key:
required: true
description:
- The API key obtained from the Memset control panel.
type: str
domain:
required: true
description:
- The zone domain name. Ensure this value has at most 250 characters.
type: str
aliases: ['name']
zone:
required: true
description:
- The zone to add the domain to (this must already exist).
type: str
"""
EXAMPLES = '''
EXAMPLES = r"""
# Create the zone domain 'test.com'
- name: Create zone domain
community.general.memset_zone_domain:
@ -63,25 +60,25 @@ EXAMPLES = '''
state: present
api_key: 5eb86c9196ab03919abcf03857163741
delegate_to: localhost
'''
"""
RETURN = '''
RETURN = r"""
memset_api:
description: Domain info from the Memset API
description: Domain info from the Memset API.
returned: when changed or state == present
type: complex
contains:
domain:
description: Domain name
description: Domain name.
returned: always
type: str
sample: "example.com"
id:
description: Domain ID
description: Domain ID.
returned: always
type: str
sample: "b0bb1ce851aeea6feeb2dc32fe83bf9c"
'''
"""
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.community.general.plugins.module_utils.memset import get_zone_id