meraki_network - Added proper response documentation (ansible#42393)

* Added proper response documentation to meraki_network * Missing colon
greut · Jul 9, 2018 · c644e3d · c644e3d
1 parent 78fd5ce
commit c644e3d
Showing 1 changed file with 37 additions and 12 deletions.
diff --git a/lib/ansible/modules/network/meraki/meraki_network.py b/lib/ansible/modules/network/meraki/meraki_network.py
@@ -91,18 +91,43 @@
 data:
     description: Information about the created or manipulated object.
     returned: info
-    type: list
-    sample:
-        [
-            {
-                "id": "N_12345",
-                "name": "YourNetwork",
-                "organizationId": "0987654321",
-                "tags": " production ",
-                "timeZone": "America/Chicago",
-                "type": "switch"
-            }
-        ]
+    type: complex
+    contains:
+      id:
+        description: Identification string of network.
+        returned: success
+        type: string
+        sample: N_12345
+      name:
+        description: Written name of network.
+        returned: success
+        type: string
+        sample: YourNet
+      organizationId:
+        description: Organization ID which owns the network.
+        returned: success
+        type: string
+        sample: 0987654321
+      tags:
+        description: Space delimited tags assigned to network.
+        returned: success
+        type: string
+        sample: " production wireless "
+      timeZone:
+        description: Timezone where network resides.
+        returned: success
+        type: string
+        sample: America/Chicago
+      type:
+        description: Functional type of network.
+        returned: success
+        type: string
+        sample: switch
+      disableMyMerakiCom:
+        description: States whether U(my.meraki.com) and other device portals should be disabled.
+        returned: success
+        type: bool
+        sample: true
 '''
 
 import os