Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix return value documentation (2/2) #63478

Merged
merged 5 commits into from
Oct 15, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@
description: Response from Vultr API
returned: success
type: complex
contains:
sample:
"vultr_block_storage_facts": [
{
"attached_to_id": null,
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/modules/cloud/vultr/_vultr_dns_domain_facts.py
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@
description: Response from Vultr API
returned: success
type: complex
contains:
sample:
"vultr_dns_domain_facts": [
{
"date_created": "2018-07-19 07:14:21",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@
description: Response from Vultr API
returned: success
type: complex
contains:
sample:
"vultr_firewall_group_facts": [
{
"date_created": "2018-07-12 10:27:14",
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/modules/cloud/vultr/_vultr_network_facts.py
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@
description: Response from Vultr API
returned: success
type: complex
contains:
sample:
"vultr_network_facts": [
{
"date_created": "2018-08-02 11:18:49",
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/modules/cloud/vultr/_vultr_os_facts.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@
description: Response from Vultr API
returned: success
type: complex
contains:
sample:
"vultr_os_facts": [
{
"arch": "x64",
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/modules/cloud/vultr/_vultr_region_facts.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@
description: Response from Vultr API
returned: success
type: complex
contains:
sample:
"vultr_region_facts": [
{
"block_storage": false,
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/modules/cloud/vultr/_vultr_server_facts.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@
description: Response from Vultr API
returned: success
type: complex
contains:
sample:
"vultr_server_facts": [
{
"allowed_bandwidth_gb": 1000,
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/modules/cloud/vultr/_vultr_ssh_key_facts.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@
description: Response from Vultr API
returned: success
type: complex
contains:
sample:
"vultr_ssh_key_facts": [
{
"date_created": "2018-02-24 15:04:01",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@
description: Response from Vultr API
returned: success
type: complex
contains:
sample:
"vultr_startup_script_facts": [
{
"date_created": "2018-07-19 08:38:36",
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/modules/cloud/vultr/_vultr_user_facts.py
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@
description: Response from Vultr API
returned: success
type: complex
contains:
sample:
"vultr_user_facts": [
{
"acls": [],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@
description: Date created of the block storage.
returned: success
type: str
sample: 2018-07-24 12:59:59
sample: "2018-07-24 12:59:59"
status:
description: Status of the block storage.
returned: success
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/modules/cloud/vultr/vultr_dns_domain_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@
description: Response from Vultr API
returned: success
type: complex
contains:
sample:
"vultr_dns_domain_info": [
{
"date_created": "2018-07-19 07:14:21",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@
description: Response from Vultr API
returned: success
type: complex
contains:
sample:
"vultr_firewall_group_info": [
{
"date_created": "2018-07-12 10:27:14",
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/modules/cloud/vultr/vultr_network_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@
description: Response from Vultr API
returned: success
type: complex
contains:
sample:
"vultr_network_info": [
{
"date_created": "2018-08-02 11:18:49",
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/modules/cloud/vultr/vultr_region_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@
description: Response from Vultr API
returned: success
type: complex
contains:
sample:
"vultr_region_info": [
{
"block_storage": false,
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/modules/cloud/vultr/vultr_server_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@
description: Response from Vultr API
returned: success
type: complex
contains:
sample:
"vultr_server_info": [
{
"allowed_bandwidth_gb": 1000,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@
description: Response from Vultr API
returned: success
type: complex
contains:
sample:
"vultr_startup_script_info": [
{
"date_created": "2018-07-19 08:38:36",
Expand Down
20 changes: 10 additions & 10 deletions lib/ansible/modules/database/postgresql/postgresql_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -182,16 +182,16 @@
returned: always
type: dict
contains:
major:
description: Extension major version.
returned: always
type: int
sample: 1
minor:
description: Extension minor version.
returned: always
type: int
sample: 0
major:
description: Extension major version.
returned: always
type: int
sample: 1
minor:
description: Extension minor version.
returned: always
type: int
sample: 0
nspname:
description: Namespace where the extension is.
returned: always
Expand Down
4 changes: 2 additions & 2 deletions lib/ansible/modules/net_tools/cloudflare_dns.py
Original file line number Diff line number Diff line change
Expand Up @@ -288,7 +288,7 @@
description: The record creation date.
returned: success
type: str
sample: 2016-03-25T19:09:42.516553Z
sample: "2016-03-25T19:09:42.516553Z"
data:
description: Additional record data.
returned: success, if type is SRV, DS, SSHFP or TLSA
Expand Down Expand Up @@ -321,7 +321,7 @@
description: Record modification date.
returned: success
type: str
sample: 2016-03-25T19:09:42.516553Z
sample: "2016-03-25T19:09:42.516553Z"
name:
description: The record name as FQDN (including _service and _proto for SRV).
returned: success
Expand Down
136 changes: 68 additions & 68 deletions lib/ansible/modules/network/f5/bigip_device_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -3225,7 +3225,7 @@
type: str
sample: pass-through
current_sessions:
descriptions:
description:
- Current sessions.
returned: queried
type: int
Expand Down Expand Up @@ -3671,72 +3671,72 @@
returned: when conditions are defined in the rule.
type: complex
contains:
case_insensitive:
description:
- The value matched on is case insensitive.
returned: when defined in the condition.
type: bool
sample: no
case_sensitive:
description:
- The value matched on is case sensitive.
returned: when defined in the condition.
type: bool
sample: yes
contains_string:
description:
- The value matches if it contains a certain string.
returned: when defined in the condition.
type: bool
sample: yes
external:
description:
- The value matched on is from the external side of a connection.
returned: when defined in the condition.
type: bool
sample: yes
http_basic_auth:
description:
- This condition matches on basic HTTP authorization.
returned: when defined in the condition.
type: bool
sample: no
http_host:
description:
- This condition matches on an HTTP host.
returned: when defined in the condition.
type: bool
sample: yes
http_uri:
description:
- This condition matches on an HTTP URI.
returned: when defined in the condition.
type: bool
sample: no
request:
description:
- This policy will match on a request.
returned: when defined in the condition.
type: bool
sample: yes
username:
description:
- Matches on a username.
returned: when defined in the condition.
type: bool
sample: yes
all:
description:
- Matches all.
returned: when defined in the condition.
type: bool
sample: yes
values:
description:
- The specified values will be matched on.
returned: when defined in the condition.
type: list
sample: ['foo.bar.com', 'baz.cool.com']
case_insensitive:
description:
- The value matched on is case insensitive.
returned: when defined in the condition.
type: bool
sample: no
case_sensitive:
description:
- The value matched on is case sensitive.
returned: when defined in the condition.
type: bool
sample: yes
contains_string:
description:
- The value matches if it contains a certain string.
returned: when defined in the condition.
type: bool
sample: yes
external:
description:
- The value matched on is from the external side of a connection.
returned: when defined in the condition.
type: bool
sample: yes
http_basic_auth:
description:
- This condition matches on basic HTTP authorization.
returned: when defined in the condition.
type: bool
sample: no
http_host:
description:
- This condition matches on an HTTP host.
returned: when defined in the condition.
type: bool
sample: yes
http_uri:
description:
- This condition matches on an HTTP URI.
returned: when defined in the condition.
type: bool
sample: no
request:
description:
- This policy will match on a request.
returned: when defined in the condition.
type: bool
sample: yes
username:
description:
- Matches on a username.
returned: when defined in the condition.
type: bool
sample: yes
all:
description:
- Matches all.
returned: when defined in the condition.
type: bool
sample: yes
values:
description:
- The specified values will be matched on.
returned: when defined in the condition.
type: list
sample: ['foo.bar.com', 'baz.cool.com']
sample: hash/dictionary of values
sample: hash/dictionary of values
sample: hash/dictionary of values
Expand Down Expand Up @@ -5586,7 +5586,7 @@
type: bool
sample: no
mptcp_rto_max:
decription:
description:
- Specifies the number of RTOs (retransmission timeouts) before declaring
the subflow dead.
returned: queried
Expand Down