doc_fragments: Clean up parameter types (cloud) (#52177)

* module_utils: Clean up parameter types (cloud)

This PR includes:

- Parameter types added
- Copyright format fixes
- Short license statement
- Description fixes (only for a few files, then I stopped :-))

* More cloud stuff

* Fix reported issue

* Fix quotes

* Use correct type

* Fix quotes

* Fix quotes

* Fix quotes

* Fix typo

* Fix boolean

lib/ansible/plugins/doc_fragments/openstack.py

@@ -1,25 +1,13 @@
-# Copyright (c) 2014 Hewlett-Packard Development Company, L.P.
-#
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2014, Hewlett-Packard Development Company, L.P.
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 
 
 class ModuleDocFragment(object):
 
     # Standard openstack documentation fragment
-    DOCUMENTATION = '''
+    DOCUMENTATION = r'''
 options:
   cloud:
     description:
@@ -30,7 +18,7 @@ options:
         or if OpenStack OS_* environment variables are present.
         If I(cloud) is a dict, it contains a complete cloud configuration like
         would be in a section of clouds.yaml.
-    required: false
+    type: str
   auth:
     description:
       - Dictionary containing auth information as needed by the cloud's auth
@@ -40,59 +28,59 @@ options:
         this param will need to contain whatever parameters that auth plugin
         requires. This parameter is not needed if a named cloud is provided or
         OpenStack OS_* environment variables are present.
-    required: false
+    type: str
   auth_type:
     description:
       - Name of the auth plugin to use. If the cloud uses something other than
         password authentication, the name of the plugin should be indicated here
         and the contents of the I(auth) parameter should be updated accordingly.
-    required: false
+    type: str
   region_name:
     description:
       - Name of the region.
-    required: false
+    type: str
   wait:
     description:
       - Should ansible wait until the requested resource is complete.
     type: bool
-    required: false
-    default: true
+    default: yes
   timeout:
     description:
       - How long should ansible wait for the requested resource.
-    required: false
+    type: int
     default: 180
   api_timeout:
     description:
       - How long should the socket layer wait before timing out for API calls.
         If this is omitted, nothing will be passed to the requests library.
-    required: false
+    type: int
   verify:
     description:
-      - Whether or not SSL API requests should be verified. Before 2.3 this defaulted to True.
+      - Whether or not SSL API requests should be verified.
+      - Before Ansible 2.3 this defaulted to C(yes).
     type: bool
-    required: false
-    aliases: ['validate_certs']
+    default: no
+    aliases: [ validate_certs ]
   cacert:
     description:
       - A path to a CA Cert bundle that can be used as part of verifying
         SSL API requests.
-    required: false
+    type: path
   cert:
     description:
       - A path to a client certificate to use as part of the SSL transaction.
-    required: false
+    type: path
   key:
     description:
       - A path to a client key to use as part of the SSL transaction.
-    required: false
+    type: path
   interface:
     description:
         - Endpoint URL type to fetch from the service catalog.
-    choices: [public, internal, admin]
-    required: false
+    type: str
+    choices: [ admin, internal, public ]
     default: public
-    aliases: ['endpoint_type']
+    aliases: [ endpoint_type ]
     version_added: "2.3"
 requirements:
   - python >= 2.7