fixed documentation for oneview modules (#2092) (#2098)

(cherry picked from commit 94cf07efbf) Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
2024-09-14 20:13:21 +02:00 · 2021-03-24 18:24:30 +01:00 · 2021-03-24 18:24:30 +01:00 · f7cb57677f
commit f7cb57677f
parent bc97d291aa
18 changed files with 46 additions and 89 deletions
--- a/plugins/doc_fragments/oneview.py
+++ b/plugins/doc_fragments/oneview.py
@ -13,12 +13,32 @@ class ModuleDocFragment(object):
    DOCUMENTATION = r'''
 options:
    config:
-      description:
+        description:
        - Path to a .json configuration file containing the OneView client configuration.
          The configuration file is optional and when used should be present in the host running the ansible commands.
          If the file path is not provided, the configuration will be loaded from environment variables.
          For links to example configuration files or how to use the environment variables verify the notes section.
-      type: path
+        type: path
+    api_version:
+        description:
+        - OneView API Version.
+        type: int
+    image_streamer_hostname:
+        description:
+        - IP address or hostname for the HPE Image Streamer REST API.
+        type: str
+    hostname:
+        description:
+        - IP address or hostname for the appliance.
+        type: str
+    username:
+        description:
+        - Username for API authentication.
+        type: str
+    password:
+        description:
+        - Password for API authentication.
+        type: str

 requirements:
  - python >= 2.7.9
--- a/plugins/modules/remote_management/oneview/oneview_datacenter_info.py
+++ b/plugins/modules/remote_management/oneview/oneview_datacenter_info.py
@ -24,6 +24,7 @@ options:
    name:
      description:
        - Data Center name.
+      type: str
    options:
      description:
        - "Retrieve additional information. Options available: 'visualContent'."
--- a/plugins/modules/remote_management/oneview/oneview_enclosure_info.py
+++ b/plugins/modules/remote_management/oneview/oneview_enclosure_info.py
@ -24,6 +24,7 @@ options:
    name:
      description:
        - Enclosure name.
+      type: str
    options:
      description:
        - "List with options to gather additional information about an Enclosure and related resources.
--- a/plugins/modules/remote_management/oneview/oneview_ethernet_network.py
+++ b/plugins/modules/remote_management/oneview/oneview_ethernet_network.py
@ -24,11 +24,13 @@ options:
                - C(present) will ensure data properties are compliant with OneView.
                - C(absent) will remove the resource from OneView, if it exists.
                - C(default_bandwidth_reset) will reset the network connection template to the default.
+        type: str
        default: present
        choices: [present, absent, default_bandwidth_reset]
    data:
        description:
            - List with Ethernet Network properties.
+        type: dict
        required: true
 extends_documentation_fragment:
 - community.general.oneview
--- a/plugins/modules/remote_management/oneview/oneview_ethernet_network_info.py
+++ b/plugins/modules/remote_management/oneview/oneview_ethernet_network_info.py
@ -23,6 +23,7 @@ options:
    name:
      description:
        - Ethernet Network name.
+      type: str
    options:
      description:
        - "List with options to gather additional information about an Ethernet Network and related resources.
--- a/plugins/modules/remote_management/oneview/oneview_fc_network.py
+++ b/plugins/modules/remote_management/oneview/oneview_fc_network.py
@ -20,11 +20,13 @@ options:
            - Indicates the desired state for the Fibre Channel Network resource.
              C(present) will ensure data properties are compliant with OneView.
              C(absent) will remove the resource from OneView, if it exists.
+        type: str
        choices: ['present', 'absent']
        required: true
    data:
        description:
            - List with the Fibre Channel Network properties.
+        type: dict
        required: true

 extends_documentation_fragment:
--- a/plugins/modules/remote_management/oneview/oneview_fc_network_info.py
+++ b/plugins/modules/remote_management/oneview/oneview_fc_network_info.py
@ -23,6 +23,7 @@ options:
    name:
      description:
        - Fibre Channel Network name.
+      type: str

 extends_documentation_fragment:
 - community.general.oneview
--- a/plugins/modules/remote_management/oneview/oneview_fcoe_network.py
+++ b/plugins/modules/remote_management/oneview/oneview_fcoe_network.py
@ -21,11 +21,13 @@ options:
            - Indicates the desired state for the FCoE Network resource.
              C(present) will ensure data properties are compliant with OneView.
              C(absent) will remove the resource from OneView, if it exists.
+        type: str
        default: present
        choices: ['present', 'absent']
    data:
        description:
            - List with FCoE Network properties.
+        type: dict
        required: true

 extends_documentation_fragment:
--- a/plugins/modules/remote_management/oneview/oneview_fcoe_network_info.py
+++ b/plugins/modules/remote_management/oneview/oneview_fcoe_network_info.py
@ -23,6 +23,7 @@ options:
    name:
      description:
        - FCoE Network name.
+      type: str
 extends_documentation_fragment:
 - community.general.oneview
 - community.general.oneview.factsparams
--- a/plugins/modules/remote_management/oneview/oneview_logical_interconnect_group.py
+++ b/plugins/modules/remote_management/oneview/oneview_logical_interconnect_group.py
@ -24,11 +24,13 @@ options:
            - Indicates the desired state for the Logical Interconnect Group resource.
              C(absent) will remove the resource from OneView, if it exists.
              C(present) will ensure data properties are compliant with OneView.
+        type: str
        choices: [absent, present]
        default: present
    data:
        description:
            - List with the Logical Interconnect Group properties.
+        type: dict
        required: true
 extends_documentation_fragment:
 - community.general.oneview
--- a/plugins/modules/remote_management/oneview/oneview_logical_interconnect_group_info.py
+++ b/plugins/modules/remote_management/oneview/oneview_logical_interconnect_group_info.py
@ -24,6 +24,7 @@ options:
    name:
      description:
        - Logical Interconnect Group name.
+      type: str
 extends_documentation_fragment:
 - community.general.oneview
 - community.general.oneview.factsparams
--- a/plugins/modules/remote_management/oneview/oneview_network_set.py
+++ b/plugins/modules/remote_management/oneview/oneview_network_set.py
@ -23,11 +23,13 @@ options:
        - Indicates the desired state for the Network Set resource.
            - C(present) will ensure data properties are compliant with OneView.
            - C(absent) will remove the resource from OneView, if it exists.
+      type: str
      default: present
      choices: ['present', 'absent']
    data:
      description:
        - List with the Network Set properties.
+      type: dict
      required: true

 extends_documentation_fragment:
--- a/plugins/modules/remote_management/oneview/oneview_network_set_info.py
+++ b/plugins/modules/remote_management/oneview/oneview_network_set_info.py
@ -23,6 +23,7 @@ options:
    name:
      description:
        - Network Set name.
+      type: str

    options:
      description:
--- a/plugins/modules/remote_management/oneview/oneview_san_manager.py
+++ b/plugins/modules/remote_management/oneview/oneview_san_manager.py
@ -24,12 +24,14 @@ options:
                - C(present) ensures data properties are compliant with OneView.
                - C(absent) removes the resource from OneView, if it exists.
                - C(connection_information_set) updates the connection information for the SAN Manager. This operation is non-idempotent.
+        type: str
        default: present
        choices: [present, absent, connection_information_set]
    data:
-      description:
-        - List with SAN Manager properties.
-      required: true
+        description:
+            - List with SAN Manager properties.
+        type: dict
+        required: true

 extends_documentation_fragment:
 - community.general.oneview
--- a/plugins/modules/remote_management/oneview/oneview_san_manager_info.py
+++ b/plugins/modules/remote_management/oneview/oneview_san_manager_info.py
@ -23,6 +23,7 @@ options:
    provider_display_name:
      description:
        - Provider Display Name.
+      type: str
    params:
      description:
        - List of params to delimit, filter and sort the list of resources.
@ -31,6 +32,7 @@ options:
           - C(count): The number of resources to return.
           - C(query): A general query string to narrow the list of resources returned.
           - C(sort): The sort order of the returned data set."
+      type: dict
 extends_documentation_fragment:
 - community.general.oneview

--- a/tests/sanity/ignore-2.10.txt
+++ b/tests/sanity/ignore-2.10.txt
@ -300,40 +300,12 @@ plugins/modules/remote_management/manageiq/manageiq_tags.py validate-modules:par
 plugins/modules/remote_management/manageiq/manageiq_tags.py validate-modules:parameter-state-invalid-choice
 plugins/modules/remote_management/oneview/oneview_datacenter_info.py validate-modules:parameter-list-no-elements
 plugins/modules/remote_management/oneview/oneview_datacenter_info.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_datacenter_info.py validate-modules:undocumented-parameter
 plugins/modules/remote_management/oneview/oneview_enclosure_info.py validate-modules:parameter-list-no-elements
 plugins/modules/remote_management/oneview/oneview_enclosure_info.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_enclosure_info.py validate-modules:undocumented-parameter
-plugins/modules/remote_management/oneview/oneview_ethernet_network.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_ethernet_network.py validate-modules:undocumented-parameter
 plugins/modules/remote_management/oneview/oneview_ethernet_network_info.py validate-modules:parameter-list-no-elements
 plugins/modules/remote_management/oneview/oneview_ethernet_network_info.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_ethernet_network_info.py validate-modules:undocumented-parameter
-plugins/modules/remote_management/oneview/oneview_fc_network.py validate-modules:doc-missing-type
-plugins/modules/remote_management/oneview/oneview_fc_network.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_fc_network.py validate-modules:undocumented-parameter
-plugins/modules/remote_management/oneview/oneview_fc_network_info.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_fc_network_info.py validate-modules:undocumented-parameter
-plugins/modules/remote_management/oneview/oneview_fcoe_network.py validate-modules:doc-missing-type
-plugins/modules/remote_management/oneview/oneview_fcoe_network.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_fcoe_network.py validate-modules:undocumented-parameter
-plugins/modules/remote_management/oneview/oneview_fcoe_network_info.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_fcoe_network_info.py validate-modules:undocumented-parameter
-plugins/modules/remote_management/oneview/oneview_logical_interconnect_group.py validate-modules:doc-missing-type
-plugins/modules/remote_management/oneview/oneview_logical_interconnect_group.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_logical_interconnect_group.py validate-modules:undocumented-parameter
-plugins/modules/remote_management/oneview/oneview_logical_interconnect_group_info.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_logical_interconnect_group_info.py validate-modules:undocumented-parameter
-plugins/modules/remote_management/oneview/oneview_network_set.py validate-modules:doc-missing-type
-plugins/modules/remote_management/oneview/oneview_network_set.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_network_set.py validate-modules:undocumented-parameter
 plugins/modules/remote_management/oneview/oneview_network_set_info.py validate-modules:parameter-list-no-elements
 plugins/modules/remote_management/oneview/oneview_network_set_info.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_network_set_info.py validate-modules:undocumented-parameter
-plugins/modules/remote_management/oneview/oneview_san_manager.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_san_manager.py validate-modules:undocumented-parameter
-plugins/modules/remote_management/oneview/oneview_san_manager_info.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_san_manager_info.py validate-modules:undocumented-parameter
 plugins/modules/remote_management/stacki/stacki_host.py validate-modules:doc-default-does-not-match-spec
 plugins/modules/remote_management/stacki/stacki_host.py validate-modules:parameter-type-not-in-doc
 plugins/modules/remote_management/stacki/stacki_host.py validate-modules:undocumented-parameter
--- a/tests/sanity/ignore-2.11.txt
+++ b/tests/sanity/ignore-2.11.txt
@ -288,40 +288,12 @@ plugins/modules/remote_management/manageiq/manageiq_tags.py validate-modules:par
 plugins/modules/remote_management/manageiq/manageiq_tags.py validate-modules:parameter-state-invalid-choice
 plugins/modules/remote_management/oneview/oneview_datacenter_info.py validate-modules:parameter-list-no-elements
 plugins/modules/remote_management/oneview/oneview_datacenter_info.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_datacenter_info.py validate-modules:undocumented-parameter
 plugins/modules/remote_management/oneview/oneview_enclosure_info.py validate-modules:parameter-list-no-elements
 plugins/modules/remote_management/oneview/oneview_enclosure_info.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_enclosure_info.py validate-modules:undocumented-parameter
-plugins/modules/remote_management/oneview/oneview_ethernet_network.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_ethernet_network.py validate-modules:undocumented-parameter
 plugins/modules/remote_management/oneview/oneview_ethernet_network_info.py validate-modules:parameter-list-no-elements
 plugins/modules/remote_management/oneview/oneview_ethernet_network_info.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_ethernet_network_info.py validate-modules:undocumented-parameter
-plugins/modules/remote_management/oneview/oneview_fc_network.py validate-modules:doc-missing-type
-plugins/modules/remote_management/oneview/oneview_fc_network.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_fc_network.py validate-modules:undocumented-parameter
-plugins/modules/remote_management/oneview/oneview_fc_network_info.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_fc_network_info.py validate-modules:undocumented-parameter
-plugins/modules/remote_management/oneview/oneview_fcoe_network.py validate-modules:doc-missing-type
-plugins/modules/remote_management/oneview/oneview_fcoe_network.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_fcoe_network.py validate-modules:undocumented-parameter
-plugins/modules/remote_management/oneview/oneview_fcoe_network_info.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_fcoe_network_info.py validate-modules:undocumented-parameter
-plugins/modules/remote_management/oneview/oneview_logical_interconnect_group.py validate-modules:doc-missing-type
-plugins/modules/remote_management/oneview/oneview_logical_interconnect_group.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_logical_interconnect_group.py validate-modules:undocumented-parameter
-plugins/modules/remote_management/oneview/oneview_logical_interconnect_group_info.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_logical_interconnect_group_info.py validate-modules:undocumented-parameter
-plugins/modules/remote_management/oneview/oneview_network_set.py validate-modules:doc-missing-type
-plugins/modules/remote_management/oneview/oneview_network_set.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_network_set.py validate-modules:undocumented-parameter
 plugins/modules/remote_management/oneview/oneview_network_set_info.py validate-modules:parameter-list-no-elements
 plugins/modules/remote_management/oneview/oneview_network_set_info.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_network_set_info.py validate-modules:undocumented-parameter
-plugins/modules/remote_management/oneview/oneview_san_manager.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_san_manager.py validate-modules:undocumented-parameter
-plugins/modules/remote_management/oneview/oneview_san_manager_info.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_san_manager_info.py validate-modules:undocumented-parameter
 plugins/modules/remote_management/stacki/stacki_host.py validate-modules:doc-default-does-not-match-spec
 plugins/modules/remote_management/stacki/stacki_host.py validate-modules:parameter-type-not-in-doc
 plugins/modules/remote_management/stacki/stacki_host.py validate-modules:undocumented-parameter
--- a/tests/sanity/ignore-2.9.txt
+++ b/tests/sanity/ignore-2.9.txt
@ -292,37 +292,9 @@ plugins/modules/remote_management/manageiq/manageiq_provider.py validate-modules
 plugins/modules/remote_management/manageiq/manageiq_provider.py validate-modules:parameter-type-not-in-doc
 plugins/modules/remote_management/manageiq/manageiq_provider.py validate-modules:undocumented-parameter
 plugins/modules/remote_management/oneview/oneview_datacenter_info.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_datacenter_info.py validate-modules:undocumented-parameter
 plugins/modules/remote_management/oneview/oneview_enclosure_info.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_enclosure_info.py validate-modules:undocumented-parameter
-plugins/modules/remote_management/oneview/oneview_ethernet_network.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_ethernet_network.py validate-modules:undocumented-parameter
 plugins/modules/remote_management/oneview/oneview_ethernet_network_info.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_ethernet_network_info.py validate-modules:undocumented-parameter
-plugins/modules/remote_management/oneview/oneview_fc_network.py validate-modules:doc-missing-type
-plugins/modules/remote_management/oneview/oneview_fc_network.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_fc_network.py validate-modules:undocumented-parameter
-plugins/modules/remote_management/oneview/oneview_fc_network_info.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_fc_network_info.py validate-modules:undocumented-parameter
-plugins/modules/remote_management/oneview/oneview_fcoe_network.py validate-modules:doc-missing-type
-plugins/modules/remote_management/oneview/oneview_fcoe_network.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_fcoe_network.py validate-modules:undocumented-parameter
-plugins/modules/remote_management/oneview/oneview_fcoe_network_info.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_fcoe_network_info.py validate-modules:undocumented-parameter
-plugins/modules/remote_management/oneview/oneview_logical_interconnect_group.py validate-modules:doc-missing-type
-plugins/modules/remote_management/oneview/oneview_logical_interconnect_group.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_logical_interconnect_group.py validate-modules:undocumented-parameter
-plugins/modules/remote_management/oneview/oneview_logical_interconnect_group_info.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_logical_interconnect_group_info.py validate-modules:undocumented-parameter
-plugins/modules/remote_management/oneview/oneview_network_set.py validate-modules:doc-missing-type
-plugins/modules/remote_management/oneview/oneview_network_set.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_network_set.py validate-modules:undocumented-parameter
 plugins/modules/remote_management/oneview/oneview_network_set_info.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_network_set_info.py validate-modules:undocumented-parameter
-plugins/modules/remote_management/oneview/oneview_san_manager.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_san_manager.py validate-modules:undocumented-parameter
-plugins/modules/remote_management/oneview/oneview_san_manager_info.py validate-modules:parameter-type-not-in-doc
-plugins/modules/remote_management/oneview/oneview_san_manager_info.py validate-modules:undocumented-parameter
 plugins/modules/remote_management/stacki/stacki_host.py validate-modules:doc-default-does-not-match-spec
 plugins/modules/remote_management/stacki/stacki_host.py validate-modules:parameter-type-not-in-doc
 plugins/modules/remote_management/stacki/stacki_host.py validate-modules:undocumented-parameter