Fix sanity issues. (#4346) (#4357)

(cherry picked from commit ca2c64b5ca) Co-authored-by: Felix Fontein <felix@fontein.de>
2024-09-14 20:13:21 +02:00 · 2022-03-14 21:30:29 +01:00 · 2022-03-14 21:30:29 +01:00 · 1bf9caa90f
commit 1bf9caa90f
parent c6ecc0f3f8
24 changed files with 28 additions and 19 deletions
--- a/plugins/cache/memcached.py
+++ b/plugins/cache/memcached.py
@ -20,6 +20,7 @@ DOCUMENTATION = '''
          - List of connection information for the memcached DBs
        default: ['127.0.0.1:11211']
        type: list
+        elements: string
        env:
          - name: ANSIBLE_CACHE_PLUGIN_CONNECTION
        ini:
--- a/plugins/inventory/cobbler.py
+++ b/plugins/inventory/cobbler.py
@ -58,6 +58,7 @@ DOCUMENTATION = '''
      group_by:
        description: Keys to group hosts by
        type: list
+        elements: string
        default: [ 'mgmt_classes', 'owners', 'status' ]
      group:
        description: Group to place all hosts into
--- a/plugins/inventory/gitlab_runners.py
+++ b/plugins/inventory/gitlab_runners.py
@ -35,7 +35,6 @@ DOCUMENTATION = '''
                version_added: 1.0.0
            type: str
            required: true
-            default: https://gitlab.com
        api_token:
            description: GitLab token for logging in.
            env:
--- a/plugins/inventory/linode.py
+++ b/plugins/inventory/linode.py
@ -54,15 +54,18 @@ DOCUMENTATION = r'''
          description: Populate inventory with instances in this region.
          default: []
          type: list
+          elements: string
        tags:
          description: Populate inventory only with instances which have at least one of the tags listed here.
          default: []
          type: list
+          elements: string
          version_added: 2.0.0
        types:
          description: Populate inventory with instances with this type.
          default: []
          type: list
+          elements: string
        strict:
          version_added: 2.0.0
        compose:
--- a/plugins/inventory/nmap.py
+++ b/plugins/inventory/nmap.py
@ -27,6 +27,7 @@ DOCUMENTATION = '''
        exclude:
            description: list of addresses to exclude
            type: list
+            elements: string
        ports:
            description: Enable/disable scanning for open ports
            type: boolean
--- a/plugins/inventory/online.py
+++ b/plugins/inventory/online.py
@ -28,6 +28,7 @@ DOCUMENTATION = r'''
        hostnames:
            description: List of preference about what to use as an hostname.
            type: list
+            elements: string
            default:
                - public_ipv4
            choices:
@ -37,6 +38,7 @@ DOCUMENTATION = r'''
        groups:
            description: List of groups.
            type: list
+            elements: string
            choices:
                - location
                - offer
--- a/plugins/inventory/scaleway.py
+++ b/plugins/inventory/scaleway.py
@ -23,6 +23,7 @@ DOCUMENTATION = r'''
        regions:
            description: Filter results on a specific Scaleway region.
            type: list
+            elements: string
            default:
                - ams1
                - par1
@ -31,6 +32,7 @@ DOCUMENTATION = r'''
        tags:
            description: Filter results on a specific tag.
            type: list
+            elements: string
        scw_profile:
            description:
            - The config profile to use in config file.
@ -51,6 +53,7 @@ DOCUMENTATION = r'''
        hostnames:
            description: List of preference about what to use as an hostname.
            type: list
+            elements: string
            default:
                - public_ipv4
            choices:
--- a/plugins/lookup/consul_kv.py
+++ b/plugins/lookup/consul_kv.py
@ -20,6 +20,7 @@ DOCUMENTATION = '''
      _raw:
        description: List of key(s) to retrieve.
        type: list
+        elements: string
      recurse:
        type: boolean
        description: If true, will retrieve all the values that have the given key as prefix.
--- a/plugins/lookup/credstash.py
+++ b/plugins/lookup/credstash.py
@ -17,11 +17,11 @@ DOCUMENTATION = '''
      _terms:
        description: term or list of terms to lookup in the credit store
        type: list
-        required: True
+        elements: string
+        required: true
      table:
        description: name of the credstash table to query
        default: 'credential-store'
-        required: True
      version:
        description: Credstash version
      region:
--- a/plugins/lookup/dnstxt.py
+++ b/plugins/lookup/dnstxt.py
@ -18,6 +18,7 @@ DOCUMENTATION = '''
        description: domain or list of domains to query TXT records from
        required: True
        type: list
+        elements: string
 '''

 EXAMPLES = """
--- a/plugins/modules/cloud/centurylink/clc_blueprint_package.py
+++ b/plugins/modules/cloud/centurylink/clc_blueprint_package.py
@ -42,7 +42,7 @@ options:
    description:
      - Whether to wait for the tasks to finish before returning.
    type: str
-    default: True
+    default: 'True'
    required: False
 requirements:
    - python = 2.7
--- a/plugins/modules/cloud/centurylink/clc_firewall_policy.py
+++ b/plugins/modules/cloud/centurylink/clc_firewall_policy.py
@ -66,8 +66,8 @@ options:
    description:
      - Whether the firewall policy is enabled or disabled
    type: str
-    choices: [True, False]
-    default: True
+    choices: ['True', 'False']
+    default: 'True'
 requirements:
    - python = 2.7
    - requests >= 2.5.0
--- a/plugins/modules/cloud/centurylink/clc_loadbalancer.py
+++ b/plugins/modules/cloud/centurylink/clc_loadbalancer.py
@ -48,7 +48,7 @@ options:
    description:
      - Port to configure on the public-facing side of the load balancer pool
    type: str
-    choices: [80, 443]
+    choices: ['80', '443']
  nodes:
    description:
      - A list of nodes that needs to be added to the load balancer pool
--- a/plugins/modules/cloud/centurylink/clc_server_snapshot.py
+++ b/plugins/modules/cloud/centurylink/clc_server_snapshot.py
@ -36,7 +36,7 @@ options:
  wait:
    description:
      - Whether to wait for the provisioning tasks to finish before returning.
-    default: True
+    default: 'True'
    required: False
    type: str
 requirements:
--- a/plugins/modules/cloud/huawei/hwc_vpc_security_group.py
+++ b/plugins/modules/cloud/huawei/hwc_vpc_security_group.py
@ -51,7 +51,6 @@ options:
              group.s
        type: str
        required: false
-        default: 0
    vpc_id:
        description:
            - Specifies the resource ID of the VPC to which the security group
--- a/plugins/modules/cloud/rackspace/rax_cdb.py
+++ b/plugins/modules/cloud/rackspace/rax_cdb.py
@ -42,7 +42,7 @@ options:
    description:
      - version of database (MySQL supports 5.1 and 5.6, MariaDB supports 10, Percona supports 5.6)
      - "The available choices are: C(5.1), C(5.6) and  C(10)."
-    default: 5.6
+    default: '5.6'
    aliases: ['version']
  state:
    type: str
--- a/plugins/modules/database/vertica/vertica_info.py
+++ b/plugins/modules/database/vertica/vertica_info.py
@ -25,7 +25,7 @@ options:
  port:
    description:
      Database port to connect to.
-    default: 5433
+    default: '5433'
    type: str
  db:
    description:
--- a/plugins/modules/database/vertica/vertica_role.py
+++ b/plugins/modules/database/vertica/vertica_role.py
@ -44,7 +44,7 @@ options:
  port:
    description:
      - Vertica cluster port to connect to.
-    default: 5433
+    default: '5433'
    type: str
  login_user:
    description:
--- a/plugins/modules/database/vertica/vertica_schema.py
+++ b/plugins/modules/database/vertica/vertica_schema.py
@ -58,7 +58,7 @@ options:
  port:
    description:
      - Vertica cluster port to connect to.
-    default: 5433
+    default: '5433'
    type: str
  login_user:
    description:
--- a/plugins/modules/database/vertica/vertica_user.py
+++ b/plugins/modules/database/vertica/vertica_user.py
@ -70,7 +70,7 @@ options:
  port:
    description:
      - Vertica cluster port to connect to.
-    default: 5433
+    default: '5433'
    type: str
  login_user:
    description:
--- a/plugins/modules/monitoring/datadog/datadog_monitor.py
+++ b/plugins/modules/monitoring/datadog/datadog_monitor.py
@ -84,7 +84,6 @@ options:
        description:
          - Dictionary of scopes to silence, with timestamps or None.
          - Each scope will be muted until the given POSIX timestamp or forever if the value is None.
-        default: ""
    notify_no_data:
        description:
          - Whether this monitor will notify when data stops reporting.
--- a/plugins/modules/net_tools/infinity/infinity.py
+++ b/plugins/modules/net_tools/infinity/infinity.py
@ -77,8 +77,8 @@ options:
    description:
      - Network family defined by Infinity, e.g. IPv4, IPv6 and Dual stack
    type: str
-    choices: [ 4, 6, dual ]
-    default: 4
+    choices: [ '4', '6', dual ]
+    default: '4'
 '''

 EXAMPLES = r'''
--- a/plugins/modules/system/open_iscsi.py
+++ b/plugins/modules/system/open_iscsi.py
@ -28,7 +28,7 @@ options:
        description:
        - The port on which the iSCSI target process listens.
        type: str
-        default: 3260
+        default: '3260'
    target:
        description:
        - The iSCSI target name.
--- a/plugins/modules/system/selinux_permissive.py
+++ b/plugins/modules/system/selinux_permissive.py
@ -20,7 +20,6 @@ options:
        - The domain that will be added or removed from the list of permissive domains.
    type: str
    required: true
-    default: ''
    aliases: [ name ]
  permissive:
    description: