Clean up module documentation (#36909)

* Clean up module documentation

This PR includes:
- Removal of `default: None` (and variations)
- Removal of `required: false`
- Fixing booleans and `type: bool` where required

* Fix remaining (new) validation issues

lib/ansible/modules/cloud/rackspace/rax.py

@@ -25,10 +25,8 @@ options:
       - Whether or not to increment a single number with the name of the
         created servers. Only applicable when used with the I(group) attribute
         or meta key.
-    default: yes
-    choices:
-      - "yes"
-      - "no"
+    type: bool
+    default: 'yes'
     version_added: 1.5
   boot_from_volume:
     description:
@@ -36,10 +34,8 @@ options:
         If C(yes) and I(image) is specified a new volume will be created at
         boot time. I(boot_volume_size) is required with I(image) to create a
         new volume at boot time.
-    default: "no"
-    choices:
-      - "yes"
-      - "no"
+    type: bool
+    default: 'no'
     version_added: 1.9
   boot_volume:
     description:
@@ -56,15 +52,14 @@ options:
     description:
       - Whether the I(boot_volume) or newly created volume from I(image) will
         be terminated when the server is terminated
-    default: false
+    type: bool
+    default: 'no'
     version_added: 1.9
   config_drive:
     description:
       - Attach read-only configuration drive to server as label config-2
-    default: no
-    choices:
-      - "yes"
-      - "no"
+    type: bool
+    default: 'no'
     version_added: 1.7
   count:
     description:
@@ -91,10 +86,8 @@ options:
         the servers matched, servers will be deleted to match the count. If
         the number of matched servers is fewer than specified in I(count)
         additional servers will be added.
-    default: no
-    choices:
-      - "yes"
-      - "no"
+    type: bool
+    default: 'no'
     version_added: 1.4
   extra_client_args:
     description:
@@ -110,11 +103,9 @@ options:
   files:
     description:
       - Files to insert into the instance. remotefilename:localcontent
-    default: null
   flavor:
     description:
       - flavor to use for the instance
-    default: null
   group:
     description:
       - host group to assign to server, is also used for idempotent operations
@@ -125,7 +116,6 @@ options:
       - image to use for the instance. Can be an C(id), C(human_id) or C(name).
         With I(boot_from_volume), a Cloud Block Storage volume will be created
         with this image
-    default: null
   instance_ids:
     description:
       - list of instance ids, currently only used when state='absent' to
@@ -134,17 +124,14 @@ options:
   key_name:
     description:
       - key pair to use on the instance
-    default: null
     aliases:
       - keypair
   meta:
     description:
       - A hash of metadata to associate with the instance
-    default: null
   name:
     description:
       - Name to give the instance
-    default: null
   networks:
     description:
       - The network to attach to the instances. If specified, you must include
@@ -169,10 +156,8 @@ options:
   wait:
     description:
       - wait for the instance to be in state 'running' before returning
-    default: "no"
-    choices:
-      - "yes"
-      - "no"
+    type: bool
+    default: 'no'
   wait_timeout:
     description:
       - how long before wait gives up, in seconds

lib/ansible/modules/cloud/rackspace/rax_cbs.py

@@ -22,21 +22,17 @@ options:
   description:
     description:
       - Description to give the volume being created
-    default: null
   image:
     description:
       - image to use for bootable volumes. Can be an C(id), C(human_id) or
         C(name). This option requires C(pyrax>=1.9.3)
-    default: null
     version_added: 1.9
   meta:
     description:
       - A hash of metadata to associate with the volume
-    default: null
   name:
     description:
       - Name to give the volume being created
-    default: null
     required: true
   size:
     description:
@@ -46,7 +42,6 @@ options:
   snapshot_id:
     description:
       - The id of the snapshot to create the volume from
-    default: null
   state:
     description:
       - Indicate desired state of the resource
@@ -66,10 +61,8 @@ options:
   wait:
     description:
       - wait for the volume to be in state 'available' before returning
-    default: "no"
-    choices:
-      - "yes"
-      - "no"
+    type: bool
+    default: 'no'
   wait_timeout:
     description:
       - how long before wait gives up, in seconds

lib/ansible/modules/cloud/rackspace/rax_cbs_attachments.py

@@ -23,17 +23,13 @@ options:
     description:
       - The device path to attach the volume to, e.g. /dev/xvde.
       - Before 2.4 this was a required field. Now it can be left to null to auto assign the device name.
-    default: null
-    required: false
   volume:
     description:
       - Name or id of the volume to attach/detach
-    default: null
     required: true
   server:
     description:
       - Name or id of the server to attach/detach
-    default: null
     required: true
   state:
     description:
@@ -46,10 +42,8 @@ options:
   wait:
     description:
       - wait for the volume to be in 'in-use'/'available' state before returning
-    default: "no"
-    choices:
-      - "yes"
-      - "no"
+    type: bool
+    default: 'no'
   wait_timeout:
     description:
       - how long before wait gives up, in seconds

lib/ansible/modules/cloud/rackspace/rax_cdb.py

@@ -24,7 +24,6 @@ options:
   name:
     description:
       - Name of the databases server instance
-    default: null
   flavor:
     description:
       - flavor to use for the instance 1 to 6 (i.e. 512MB to 16GB)
@@ -53,8 +52,8 @@ options:
   wait:
     description:
       - wait for the instance to be in state 'running' before returning
-    default: "no"
-    choices: [ "yes", "no" ]
+    type: bool
+    default: 'no'
   wait_timeout:
     description:
       - how long before wait gives up, in seconds

lib/ansible/modules/cloud/rackspace/rax_cdb_database.py

@@ -21,11 +21,9 @@ options:
   cdb_id:
     description:
       - The databases server UUID
-    default: null
   name:
     description:
       - Name to give to the database
-    default: null
   character_set:
     description:
       - Set of symbols and encodings

lib/ansible/modules/cloud/rackspace/rax_cdb_user.py

@@ -22,15 +22,12 @@ options:
   cdb_id:
     description:
       - The databases server UUID
-    default: null
   db_username:
     description:
       - Name of the database user
-    default: null
   db_password:
     description:
       - Database user password
-    default: null
   databases:
     description:
       - Name of the databases that the user can access

lib/ansible/modules/cloud/rackspace/rax_clb.py

@@ -32,11 +32,9 @@ options:
   meta:
     description:
       - A hash of metadata to associate with the instance
-    default: null
   name:
     description:
       - Name to give the load balancer
-    default: null
   port:
     description:
       - Port for the balancer being created
@@ -90,10 +88,8 @@ options:
   wait:
     description:
       - wait for the balancer to be in state 'running' before returning
-    default: "no"
-    choices:
-      - "yes"
-      - "no"
+    type: bool
+    default: 'no'
   wait_timeout:
     description:
       - how long before wait gives up, in seconds

lib/ansible/modules/cloud/rackspace/rax_facts.py

@@ -29,7 +29,6 @@ options:
   name:
     description:
       - Server name to retrieve facts for
-    default: null
 author: "Matt Martz (@sivel)"
 extends_documentation_fragment: rackspace.openstack
 '''

lib/ansible/modules/cloud/rackspace/rax_files_objects.py

@@ -24,15 +24,12 @@ options:
     description:
       - Optionally clear existing metadata when applying metadata to existing objects.
         Selecting this option is only appropriate when setting type=meta
-    choices:
-      - "yes"
-      - "no"
-    default: "no"
+    type: bool
+    default: 'no'
   container:
     description:
       - The container to use for file object operations.
     required: true
-    default: null
   dest:
     description:
       - The destination of a "get" operation; i.e. a local directory, "/home/user/myfolder".
@@ -42,11 +39,9 @@ options:
     description:
       - Used to set an expiration on a file or folder uploaded to Cloud Files.
         Requires an integer, specifying expiration in seconds
-    default: null
   meta:
     description:
       - A hash of items to set as metadata values on an uploaded file or folder
-    default: null
   method:
     description:
       - The method of operation to be performed.  For example, put to upload files
@@ -62,16 +57,13 @@ options:
       - Source from which to upload files.  Used to specify a remote object as a source for
         an operation, i.e. a file name, "file1", or a comma-separated list of remote objects,
         "file1,file2,file17".  src and dest are mutually exclusive on remote-only object operations
-    default: null
   structure:
     description:
       - Used to specify whether to maintain nested directory structure when downloading objects
         from Cloud Files.  Setting to false downloads the contents of a container to a single,
         flat directory
-    choices:
-      - yes
-      - "no"
-    default: "yes"
+    type: bool
+    default: 'yes'
   state:
     description:
       - Indicate desired state of the resource

lib/ansible/modules/cloud/rackspace/rax_keypair.py

@@ -26,7 +26,6 @@ options:
   public_key:
     description:
       - Public Key string to upload. Can be a file path or string
-    default: null
   state:
     description:
       - Indicate desired state of the resource

lib/ansible/modules/cloud/rackspace/rax_meta.py

@@ -29,11 +29,9 @@ options:
   name:
     description:
       - Server name to modify metadata for
-    default: null
   meta:
     description:
       - A hash of metadata to associate with the instance
-    default: null
 author: "Matt Martz (@sivel)"
 extends_documentation_fragment: rackspace.openstack
 '''

lib/ansible/modules/cloud/rackspace/rax_network.py

@@ -29,11 +29,9 @@ options:
   label:
     description:
      - Label (name) to give the network
-    default: null
   cidr:
     description:
      - cidr of the network being created
-    default: null
 author:
     - "Christopher H. Laco (@claco)"
     - "Jesse Keating (@j2sol)"

lib/ansible/modules/cloud/rackspace/rax_queue.py

@@ -22,7 +22,6 @@ options:
   name:
     description:
       - Name to give the queue
-    default: null
   state:
     description:
       - Indicate desired state of the resource

lib/ansible/modules/cloud/rackspace/rax_scaling_group.py

@@ -22,10 +22,8 @@ options:
   config_drive:
     description:
       - Attach read-only configuration drive to server as label config-2
-    default: no
-    choices:
-      - "yes"
-      - "no"
+    type: bool
+    default: 'no'
     version_added: 1.8
   cooldown:
     description:
@@ -42,7 +40,6 @@ options:
   files:
     description:
       - 'Files to insert into the instance. Hash of C(remotepath: localpath)'
-    default: null
   flavor:
     description:
       - flavor to use for the instance
@@ -54,7 +51,6 @@ options:
   key_name:
     description:
       - key pair to use on the instance
-    default: null
   loadbalancers:
     description:
       - List of load balancer C(id) and C(port) hashes
@@ -66,7 +62,6 @@ options:
   meta:
     description:
       - A hash of metadata to associate with the instance
-    default: null
   min_entities:
     description:
       - The minimum number of entities that are allowed in the scaling group.
@@ -104,10 +99,8 @@ options:
     description:
       - wait for the scaling group to finish provisioning the minimum amount of
         servers
-    default: "no"
-    choices:
-      - "yes"
-      - "no"
+    type: bool
+    default: 'no'
   wait_timeout:
     description:
       - how long before wait gives up, in seconds