diff --git a/lib/ansible/plugins/callback/tree.py b/lib/ansible/plugins/callback/tree.py index 209afafc648..c103275f67c 100644 --- a/lib/ansible/plugins/callback/tree.py +++ b/lib/ansible/plugins/callback/tree.py @@ -7,7 +7,7 @@ __metaclass__ = type DOCUMENTATION = ''' callback: tree - callback_type: notification + type: notification requirements: - invoked in the command line short_description: Save host events to files diff --git a/lib/ansible/plugins/connection/paramiko_ssh.py b/lib/ansible/plugins/connection/paramiko_ssh.py index 96a76d67461..7a2f61f2f3f 100644 --- a/lib/ansible/plugins/connection/paramiko_ssh.py +++ b/lib/ansible/plugins/connection/paramiko_ssh.py @@ -6,7 +6,7 @@ __metaclass__ = type DOCUMENTATION = """ author: Ansible Core Team - connection: paramiko + connection: paramiko_ssh short_description: Run tasks via python ssh (paramiko) description: - Use the python ssh implementation (Paramiko) to connect to targets diff --git a/lib/ansible/plugins/inventory/auto.py b/lib/ansible/plugins/inventory/auto.py index cf4ed0c347c..ddcb705e28c 100644 --- a/lib/ansible/plugins/inventory/auto.py +++ b/lib/ansible/plugins/inventory/auto.py @@ -9,6 +9,7 @@ DOCUMENTATION = ''' plugin_type: inventory author: - Matt Davis <@nitzmahone> + version_added: "2.5" short_description: Loads and executes an inventory plugin specified in a YAML config description: - By whitelisting C(auto) inventory plugin, any YAML inventory config file with a diff --git a/lib/ansible/plugins/inventory/toml.py b/lib/ansible/plugins/inventory/toml.py index b4c8de1ce67..7d134cabc16 100644 --- a/lib/ansible/plugins/inventory/toml.py +++ b/lib/ansible/plugins/inventory/toml.py @@ -153,7 +153,7 @@ class InventoryModule(BaseFileInventoryPlugin): NAME = 'toml' def _parse_group(self, group, group_data): - if not isinstance(group_data, (MutableMapping, type(None))): + if group_data is not None and not isinstance(group_data, MutableMapping): self.display.warning("Skipping '%s' as this is not a valid group definition" % group) return diff --git a/lib/ansible/plugins/lookup/config.py b/lib/ansible/plugins/lookup/config.py index 20ec25427fc..b51f68158b8 100644 --- a/lib/ansible/plugins/lookup/config.py +++ b/lib/ansible/plugins/lookup/config.py @@ -53,6 +53,7 @@ RETURN = """ _raw: description: - value(s) of the key(s) in the config + type: raw """ from ansible import constants as C diff --git a/lib/ansible/plugins/lookup/csvfile.py b/lib/ansible/plugins/lookup/csvfile.py index e0ffa69be94..afd26c36baa 100644 --- a/lib/ansible/plugins/lookup/csvfile.py +++ b/lib/ansible/plugins/lookup/csvfile.py @@ -61,6 +61,8 @@ RETURN = """ _raw: description: - value(s) stored in file column + type: list + elements: str """ import codecs diff --git a/lib/ansible/plugins/lookup/file.py b/lib/ansible/plugins/lookup/file.py index 3ce41559bd6..029b1796a1b 100644 --- a/lib/ansible/plugins/lookup/file.py +++ b/lib/ansible/plugins/lookup/file.py @@ -45,6 +45,8 @@ RETURN = """ _raw: description: - content of file(s) + type: list + elements: str """ from ansible.errors import AnsibleError, AnsibleParserError diff --git a/lib/ansible/plugins/lookup/fileglob.py b/lib/ansible/plugins/lookup/fileglob.py index 05628defd8e..af424b310d5 100644 --- a/lib/ansible/plugins/lookup/fileglob.py +++ b/lib/ansible/plugins/lookup/fileglob.py @@ -41,6 +41,8 @@ RETURN = """ _list: description: - list of files + type: list + elements: path """ import os diff --git a/lib/ansible/plugins/lookup/first_found.py b/lib/ansible/plugins/lookup/first_found.py index 1668f51f2b7..e9dd957290e 100644 --- a/lib/ansible/plugins/lookup/first_found.py +++ b/lib/ansible/plugins/lookup/first_found.py @@ -99,6 +99,8 @@ RETURN = """ _raw: description: - path to file found + type: list + elements: path """ import os diff --git a/lib/ansible/plugins/lookup/indexed_items.py b/lib/ansible/plugins/lookup/indexed_items.py index cd25ba15fa6..42a30fe47fe 100644 --- a/lib/ansible/plugins/lookup/indexed_items.py +++ b/lib/ansible/plugins/lookup/indexed_items.py @@ -31,6 +31,7 @@ RETURN = """ description: - list with each item.0 giving you the position and item.1 the value type: list + elements: list """ from ansible.errors import AnsibleError diff --git a/lib/ansible/plugins/lookup/ini.py b/lib/ansible/plugins/lookup/ini.py index f886a8d9b1b..10b691d4f37 100644 --- a/lib/ansible/plugins/lookup/ini.py +++ b/lib/ansible/plugins/lookup/ini.py @@ -56,6 +56,8 @@ RETURN = """ _raw: description: - value(s) of the key(s) in the ini file + type: list + elements: str """ import os import re diff --git a/lib/ansible/plugins/lookup/lines.py b/lib/ansible/plugins/lookup/lines.py index 2707d6cbf3b..6a10cfcccac 100644 --- a/lib/ansible/plugins/lookup/lines.py +++ b/lib/ansible/plugins/lookup/lines.py @@ -37,6 +37,8 @@ RETURN = """ _list: description: - lines of stdout from command + type: list + elements: str """ import subprocess diff --git a/lib/ansible/plugins/lookup/list.py b/lib/ansible/plugins/lookup/list.py index 60ea53151ac..05a890c496d 100644 --- a/lib/ansible/plugins/lookup/list.py +++ b/lib/ansible/plugins/lookup/list.py @@ -27,6 +27,8 @@ EXAMPLES = """ RETURN = """ _list: description: basically the same as you fed in + type: list + elements: raw """ from ansible.module_utils.common._collections_compat import Sequence diff --git a/lib/ansible/plugins/lookup/password.py b/lib/ansible/plugins/lookup/password.py index f69c610991c..e1d9b3db80c 100644 --- a/lib/ansible/plugins/lookup/password.py +++ b/lib/ansible/plugins/lookup/password.py @@ -95,6 +95,8 @@ RETURN = """ _raw: description: - a password + type: list + elements: str """ import os diff --git a/lib/ansible/plugins/lookup/pipe.py b/lib/ansible/plugins/lookup/pipe.py index 94ad0104343..1045bbd30eb 100644 --- a/lib/ansible/plugins/lookup/pipe.py +++ b/lib/ansible/plugins/lookup/pipe.py @@ -40,6 +40,8 @@ RETURN = r""" _string: description: - stdout from command + type: list + elements: str """ import subprocess diff --git a/lib/ansible/plugins/lookup/random_choice.py b/lib/ansible/plugins/lookup/random_choice.py index 05b4080d489..da2843a73e1 100644 --- a/lib/ansible/plugins/lookup/random_choice.py +++ b/lib/ansible/plugins/lookup/random_choice.py @@ -30,6 +30,7 @@ RETURN = """ _raw: description: - random item + type: raw """ import random diff --git a/lib/ansible/plugins/lookup/sequence.py b/lib/ansible/plugins/lookup/sequence.py index 12625c0505a..7312589ea24 100644 --- a/lib/ansible/plugins/lookup/sequence.py +++ b/lib/ansible/plugins/lookup/sequence.py @@ -74,6 +74,7 @@ RETURN = """ description: - A list containing generated sequence of items type: list + elements: str """ from re import compile as re_compile, IGNORECASE diff --git a/lib/ansible/plugins/lookup/template.py b/lib/ansible/plugins/lookup/template.py index c04b5e0d6a0..cb4c8c670dd 100644 --- a/lib/ansible/plugins/lookup/template.py +++ b/lib/ansible/plugins/lookup/template.py @@ -55,6 +55,8 @@ EXAMPLES = """ RETURN = """ _raw: description: file(s) content after templating + type: list + elements: raw """ from copy import deepcopy diff --git a/lib/ansible/plugins/lookup/together.py b/lib/ansible/plugins/lookup/together.py index 1234ac6204f..3c03cf7a161 100644 --- a/lib/ansible/plugins/lookup/together.py +++ b/lib/ansible/plugins/lookup/together.py @@ -32,6 +32,8 @@ EXAMPLES = """ RETURN = """ _list: description: synchronized list + type: list + elements: list """ from ansible.errors import AnsibleError from ansible.module_utils.six.moves import zip_longest diff --git a/lib/ansible/plugins/lookup/unvault.py b/lib/ansible/plugins/lookup/unvault.py index 820da6c2d80..18438da8805 100644 --- a/lib/ansible/plugins/lookup/unvault.py +++ b/lib/ansible/plugins/lookup/unvault.py @@ -26,6 +26,8 @@ RETURN = """ _raw: description: - content of file(s) as bytes + type: list + elements: raw """ from ansible.errors import AnsibleParserError diff --git a/lib/ansible/plugins/lookup/url.py b/lib/ansible/plugins/lookup/url.py index 3896c8b57cb..1c24ebf8e5f 100644 --- a/lib/ansible/plugins/lookup/url.py +++ b/lib/ansible/plugins/lookup/url.py @@ -50,7 +50,7 @@ options: - name: ANSIBLE_LOOKUP_URL_FORCE ini: - section: url_lookup - - key: force + key: force timeout: description: How long to wait for the server to send data before giving up type: float @@ -62,7 +62,7 @@ options: - name: ANSIBLE_LOOKUP_URL_TIMEOUT ini: - section: url_lookup - - key: timeout + key: timeout http_agent: description: User-Agent to use in the request type: string @@ -73,7 +73,7 @@ options: - name: ANSIBLE_LOOKUP_URL_AGENT ini: - section: url_lookup - - key: agent + key: agent force_basic_auth: description: Force basic authentication type: boolean @@ -85,7 +85,7 @@ options: - name: ANSIBLE_LOOKUP_URL_AGENT ini: - section: url_lookup - - key: agent + key: agent follow_redirects: description: String of urllib2, all/yes, safe, none to determine how redirects are followed, see RedirectHandlerFactory for more information type: string @@ -97,7 +97,7 @@ options: - name: ANSIBLE_LOOKUP_URL_FOLLOW_REDIRECTS ini: - section: url_lookup - - key: follow_redirects + key: follow_redirects use_gssapi: description: Use GSSAPI handler of requests type: boolean @@ -109,7 +109,7 @@ options: - name: ANSIBLE_LOOKUP_URL_USE_GSSAPI ini: - section: url_lookup - - key: use_gssapi + key: use_gssapi unix_socket: description: String of file system path to unix socket file to use when establishing connection to the provided url type: string @@ -120,7 +120,7 @@ options: - name: ANSIBLE_LOOKUP_URL_UNIX_SOCKET ini: - section: url_lookup - - key: unix_socket + key: unix_socket ca_path: description: String of file system path to CA cert bundle to use type: string @@ -131,7 +131,7 @@ options: - name: ANSIBLE_LOOKUP_URL_CA_PATH ini: - section: url_lookup - - key: ca_path + key: ca_path unredirected_headers: description: A list of headers to not attach on a redirected request type: list @@ -142,7 +142,7 @@ options: - name: ANSIBLE_LOOKUP_URL_UNREDIR_HEADERS ini: - section: url_lookup - - key: unredirected_headers + key: unredirected_headers """ EXAMPLES = """ @@ -166,6 +166,8 @@ EXAMPLES = """ RETURN = """ _list: description: list of list of lines or content of url(s) + type: list + elements: str """ from ansible.errors import AnsibleError diff --git a/lib/ansible/plugins/lookup/vars.py b/lib/ansible/plugins/lookup/vars.py index 5895b93f9fc..9132a5a5511 100644 --- a/lib/ansible/plugins/lookup/vars.py +++ b/lib/ansible/plugins/lookup/vars.py @@ -63,6 +63,8 @@ RETURN = """ _value: description: - value of the variables requested. + type: list + elements: raw """ from ansible.errors import AnsibleError, AnsibleUndefinedVariable