Add types to docker module fragments (#50002)

lib/ansible/utils/module_docs_fragments/docker.py

@@ -1,103 +1,94 @@
-# This file is part of Ansible
+# -*- coding: utf-8 -*-
-#
+
-# Ansible is free software: you can redistribute it and/or modify
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-#
 
 
 class ModuleDocFragment(object):
 
     # Docker doc fragment
-    DOCUMENTATION = '''
+    DOCUMENTATION = r'''
 
 options:
     docker_host:
         description:
-            - "The URL or Unix socket path used to connect to the Docker API. To connect to a remote host, provide the
+            - The URL or Unix socket path used to connect to the Docker API. To connect to a remote host, provide the
               TCP connection string. For example, C(tcp://192.0.2.23:2376). If TLS is used to encrypt the connection,
-              the module will automatically replace C(tcp) in the connection URL with C(https)."
+              the module will automatically replace C(tcp) in the connection URL with C(https).
             - If the value is not specified in the task, the value of environment variable C(DOCKER_HOST) will be used
               instead. If the environment variable is not set, the default value will be used.
-        default: "unix://var/run/docker.sock"
+        type: str
-        aliases:
+        default: unix://var/run/docker.sock
-            - docker_url
+        aliases: [ docker_url ]
     tls_hostname:
         description:
             - When verifying the authenticity of the Docker Host server, provide the expected name of the server.
             - If the value is not specified in the task, the value of environment variable C(DOCKER_TLS_HOSTNAME) will
               be used instead. If the environment variable is not set, the default value will be used.
+        type: str
         default: localhost
     api_version:
         description:
-            - The version of the Docker API running on the Docker Host. Defaults to the latest version of the API
+            - The version of the Docker API running on the Docker Host.
-              supported by docker-py.
+            - Defaults to the latest version of the API supported by docker-py.
             - If the value is not specified in the task, the value of environment variable C(DOCKER_API_VERSION) will be
               used instead. If the environment variable is not set, the default value will be used.
-        default: 'auto'
+        type: str
-        aliases:
+        default: auto
-            - docker_api_version
+        aliases: [ docker_api_version ]
     timeout:
         description:
             - The maximum amount of time in seconds to wait on a response from the API.
             - If the value is not specified in the task, the value of environment variable C(DOCKER_TIMEOUT) will be used
               instead. If the environment variable is not set, the default value will be used.
+        type: int
         default: 60
     cacert_path:
         description:
             - Use a CA certificate when performing server verification by providing the path to a CA certificate file.
             - If the value is not specified in the task and the environment variable C(DOCKER_CERT_PATH) is set,
               the file C(ca.pem) from the directory specified in the environment variable C(DOCKER_CERT_PATH) will be used.
-        aliases:
+        type: str
-            - tls_ca_cert
+        aliases: [ tls_ca_cert ]
     cert_path:
         description:
             - Path to the client's TLS certificate file.
             - If the value is not specified in the task and the environment variable C(DOCKER_CERT_PATH) is set,
               the file C(cert.pem) from the directory specified in the environment variable C(DOCKER_CERT_PATH) will be used.
-        aliases:
+        type: str
-            - tls_client_cert
+        aliases: [ tls_client_cert ]
     key_path:
         description:
             - Path to the client's TLS key file.
             - If the value is not specified in the task and the environment variable C(DOCKER_CERT_PATH) is set,
               the file C(key.pem) from the directory specified in the environment variable C(DOCKER_CERT_PATH) will be used.
-        aliases:
+        type: str
-            - tls_client_key
+        aliases: [ tls_client_key ]
     ssl_version:
         description:
             - Provide a valid SSL version number. Default value determined by ssl.py module.
             - If the value is not specified in the task, the value of environment variable C(DOCKER_SSL_VERSION) will be
               used instead.
+        type: str
     tls:
         description:
             -  Secure the connection to the API by using TLS without verifying the authenticity of the Docker host
                server.
             - If the value is not specified in the task, the value of environment variable C(DOCKER_TLS) will be used
               instead. If the environment variable is not set, the default value will be used.
-        default: false
         type: bool
+        default: false
     tls_verify:
         description:
             - Secure the connection to the API by using TLS and verifying the authenticity of the Docker host server.
             - If the value is not specified in the task, the value of environment variable C(DOCKER_TLS_VERIFY) will be
               used instead. If the environment variable is not set, the default value will be used.
-        default: false
         type: bool
+        default: false
     debug:
         description:
             - Debug mode
-        default: false
         type: bool
+        default: false
 
 notes:
     - Connect to the Docker daemon by providing parameters with each task or by defining environment variables.