Fix return value documentation (2/2) (ansible#63478)

* Fix return value documentation (2/2). * Avoid validation errors for missing 'contains:'. * Convert JSON text to JSON dict. * example -> sample. * Fix YAML.
garnaud · Oct 15, 2019 · 4bc298a · 4bc298a
1 parent 20be869
commit 4bc298a
Show file tree

Hide file tree

Showing 50 changed files with 427 additions and 400 deletions.
diff --git a/lib/ansible/modules/cloud/vultr/_vultr_block_storage_facts.py b/lib/ansible/modules/cloud/vultr/_vultr_block_storage_facts.py
@@ -72,7 +72,7 @@
   description: Response from Vultr API
   returned: success
   type: complex
-  contains:
+  sample:
     "vultr_block_storage_facts": [
       {
         "attached_to_id": null,

diff --git a/lib/ansible/modules/cloud/vultr/_vultr_dns_domain_facts.py b/lib/ansible/modules/cloud/vultr/_vultr_dns_domain_facts.py
@@ -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",

diff --git a/lib/ansible/modules/cloud/vultr/_vultr_firewall_group_facts.py b/lib/ansible/modules/cloud/vultr/_vultr_firewall_group_facts.py
@@ -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",

diff --git a/lib/ansible/modules/cloud/vultr/_vultr_network_facts.py b/lib/ansible/modules/cloud/vultr/_vultr_network_facts.py
@@ -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",

diff --git a/lib/ansible/modules/cloud/vultr/_vultr_os_facts.py b/lib/ansible/modules/cloud/vultr/_vultr_os_facts.py
@@ -73,7 +73,7 @@
   description: Response from Vultr API
   returned: success
   type: complex
-  contains:
+  sample:
     "vultr_os_facts": [
       {
         "arch": "x64",

diff --git a/lib/ansible/modules/cloud/vultr/_vultr_region_facts.py b/lib/ansible/modules/cloud/vultr/_vultr_region_facts.py
@@ -73,7 +73,7 @@
   description: Response from Vultr API
   returned: success
   type: complex
-  contains:
+  sample:
     "vultr_region_facts": [
       {
         "block_storage": false,

diff --git a/lib/ansible/modules/cloud/vultr/_vultr_server_facts.py b/lib/ansible/modules/cloud/vultr/_vultr_server_facts.py
@@ -73,7 +73,7 @@
   description: Response from Vultr API
   returned: success
   type: complex
-  contains:
+  sample:
     "vultr_server_facts": [
       {
         "allowed_bandwidth_gb": 1000,

diff --git a/lib/ansible/modules/cloud/vultr/_vultr_ssh_key_facts.py b/lib/ansible/modules/cloud/vultr/_vultr_ssh_key_facts.py
@@ -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",

diff --git a/lib/ansible/modules/cloud/vultr/_vultr_startup_script_facts.py b/lib/ansible/modules/cloud/vultr/_vultr_startup_script_facts.py
@@ -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",

diff --git a/lib/ansible/modules/cloud/vultr/_vultr_user_facts.py b/lib/ansible/modules/cloud/vultr/_vultr_user_facts.py
@@ -72,7 +72,7 @@
   description: Response from Vultr API
   returned: success
   type: complex
-  contains:
+  sample:
     "vultr_user_facts": [
       {
         "acls": [],

diff --git a/lib/ansible/modules/cloud/vultr/vultr_block_storage_info.py b/lib/ansible/modules/cloud/vultr/vultr_block_storage_info.py
@@ -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

diff --git a/lib/ansible/modules/cloud/vultr/vultr_dns_domain_info.py b/lib/ansible/modules/cloud/vultr/vultr_dns_domain_info.py
@@ -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",

diff --git a/lib/ansible/modules/cloud/vultr/vultr_firewall_group_info.py b/lib/ansible/modules/cloud/vultr/vultr_firewall_group_info.py
@@ -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",

diff --git a/lib/ansible/modules/cloud/vultr/vultr_network_info.py b/lib/ansible/modules/cloud/vultr/vultr_network_info.py
@@ -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",

diff --git a/lib/ansible/modules/cloud/vultr/vultr_region_info.py b/lib/ansible/modules/cloud/vultr/vultr_region_info.py
@@ -70,7 +70,7 @@
   description: Response from Vultr API
   returned: success
   type: complex
-  contains:
+  sample:
     "vultr_region_info": [
       {
         "block_storage": false,

diff --git a/lib/ansible/modules/cloud/vultr/vultr_server_info.py b/lib/ansible/modules/cloud/vultr/vultr_server_info.py
@@ -70,7 +70,7 @@
   description: Response from Vultr API
   returned: success
   type: complex
-  contains:
+  sample:
     "vultr_server_info": [
       {
         "allowed_bandwidth_gb": 1000,

diff --git a/lib/ansible/modules/cloud/vultr/vultr_startup_script_info.py b/lib/ansible/modules/cloud/vultr/vultr_startup_script_info.py
@@ -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",

diff --git a/lib/ansible/modules/database/postgresql/postgresql_info.py b/lib/ansible/modules/database/postgresql/postgresql_info.py
@@ -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

diff --git a/lib/ansible/modules/net_tools/cloudflare_dns.py b/lib/ansible/modules/net_tools/cloudflare_dns.py
@@ -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
@@ -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

diff --git a/lib/ansible/modules/network/f5/bigip_device_info.py b/lib/ansible/modules/network/f5/bigip_device_info.py
@@ -3225,7 +3225,7 @@
       type: str
       sample: pass-through
     current_sessions:
-      descriptions:
+      description:
         - Current sessions.
       returned: queried
       type: int
@@ -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
@@ -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