Convert to reduced list of known types (#50010)

This commit is contained in:
Dag Wieers 2018-12-18 22:25:30 +01:00 committed by Jordan Borean
commit 05c6ff79f9
908 changed files with 4822 additions and 4821 deletions

View file

@ -211,7 +211,7 @@ RETURN = '''
cmd:
description: pip command used by the module
returned: success
type: string
type: str
sample: pip2 install ansible six
name:
description: list of python modules targetted by pip
@ -221,17 +221,17 @@ name:
requirements:
description: Path to the requirements file
returned: success, if a requirements file was provided
type: string
type: str
sample: "/srv/git/project/requirements.txt"
version:
description: Version of the package specified in 'name'
returned: success, if a name and version were provided
type: string
type: str
sample: "2.5.1"
virtualenv:
description: Path to the virtualenv
returned: success, if a virtualenv path was provided
type: string
type: str
sample: "/tmp/virtualenv"
'''

View file

@ -120,17 +120,17 @@ RETURN = '''
changed:
description: Whether Yarn changed any package data
returned: always
type: boolean
type: bool
sample: true
msg:
description: Provides an error message if Yarn syntax was incorrect
returned: failure
type: string
type: str
sample: "Package must be explicitly named when uninstalling."
invocation:
description: Parameters and values used during execution
returned: success
type: dictionary
type: dict
sample: {
"module_args": {
"executable": null,
@ -147,7 +147,7 @@ invocation:
out:
description: Output generated from Yarn with emojis removed.
returned: always
type: string
type: str
sample: "yarn add v0.16.1[1/4] Resolving packages...[2/4] Fetching packages...[3/4] Linking dependencies...[4/4]
Building fresh packages...success Saved lockfile.success Saved 1 new dependency..left-pad@1.1.3 Done in 0.59s."
'''

View file

@ -243,7 +243,7 @@ RETURN = '''
cache_updated:
description: if the cache was updated or not
returned: success, in some cases
type: boolean
type: bool
sample: True
cache_update_time:
description: time of the last cache update (0 if unknown)
@ -253,12 +253,12 @@ cache_update_time:
stdout:
description: output from apt
returned: success, when needed
type: string
type: str
sample: "Reading package lists...\nBuilding dependency tree...\nReading state information...\nThe following extra packages will be installed:\n apache2-bin ..."
stderr:
description: error output from apt
returned: success, when needed
type: string
type: str
sample: "AH00558: apache2: Could not reliably determine the server's fully qualified domain name, using 127.0.1.1. Set the 'ServerName' directive globally to ..."
''' # NOQA

View file

@ -121,12 +121,12 @@ RETURN = r'''
command:
description: The exact flatpak command that was executed
returned: When a flatpak command has been executed
type: string
type: str
sample: "/usr/bin/flatpak install --user -y flathub org.gnome.Calculator"
msg:
description: Module error message
returned: failure
type: string
type: str
sample: "Executable '/usr/local/bin/flatpak' was not found on the system."
rc:
description: Return code from flatpak binary
@ -136,12 +136,12 @@ rc:
stderr:
description: Error output from flatpak binary
returned: When a flatpak command has been executed
type: string
type: str
sample: "error: Error searching remote flathub: Can't find ref org.gnome.KDE"
stdout:
description: Output from flatpak binary
returned: When a flatpak command has been executed
type: string
type: str
sample: "org.gnome.Calendar/x86_64/stable\tcurrent\norg.gnome.gitg/x86_64/stable\tcurrent\n"
'''

View file

@ -115,12 +115,12 @@ RETURN = r'''
command:
description: The exact flatpak command that was executed
returned: When a flatpak command has been executed
type: string
type: str
sample: "/usr/bin/flatpak remote-add --system flatpak-test https://dl.flathub.org/repo/flathub.flatpakrepo"
msg:
description: Module error message
returned: failure
type: string
type: str
sample: "Executable '/usr/local/bin/flatpak' was not found on the system."
rc:
description: Return code from flatpak binary
@ -130,12 +130,12 @@ rc:
stderr:
description: Error output from flatpak binary
returned: When a flatpak command has been executed
type: string
type: str
sample: "error: GPG verification enabled, but no summary found (check that the configured URL in remote config is correct)\n"
stdout:
description: Output from flatpak binary
returned: When a flatpak command has been executed
type: string
type: str
sample: "flathub\tFlathub\thttps://dl.flathub.org/repo/\t1\t\n"
'''

View file

@ -188,7 +188,7 @@ RETURN = '''
repo:
description: Name of the repo that the action was performed on.
returned: success
type: string
type: str
sample: my_repo
'''

View file

@ -89,15 +89,15 @@ EXAMPLES = '''
RETURN = '''
classic:
description: Whether or not the snaps were installed with the classic confinement
type: boolean
type: bool
returned: When snaps are installed
channel:
description: The channel the snaps were installed from
type: string
type: str
returned: When snaps are installed
cmd:
description: The command that was executed on the host
type: string
type: str
returned: When changed is true
snaps_installed:
description: The list of actually installed snaps

View file

@ -92,11 +92,11 @@ RETURN = '''
stdout:
description: stdout of swupd
returned: always
type: string
type: str
stderr:
description: stderr of swupd
returned: always
type: string
type: str
'''
import os

View file

@ -72,7 +72,7 @@ RETURN = '''
msg:
description: Message about results
returned: success
type: string
type: str
sample: "System Upgraded"
packages:
description: Packages that are affected/would be affected

View file

@ -373,12 +373,12 @@ RETURN = '''
repo:
description: repository name
returned: success
type: string
type: str
sample: "epel"
state:
description: state of the target, after execution
returned: success
type: string
type: str
sample: "present"
'''