Fix azure_rm_publicipaddress documentation page throws error (#822)

* fix azure_rm_publicipaddress documentation page throws error * delete unnecessary ignore
ansible-collections · Apr 15, 2022 · 367b63d · 367b63d
1 parent 3342043
commit 367b63d
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 16 deletions.
diff --git a/plugins/modules/azure_rm_publicipaddress.py b/plugins/modules/azure_rm_publicipaddress.py
@@ -124,7 +124,7 @@
         dns_settings:
             description:
                 - The FQDN of the DNS record associated with the public IP address.
-            returns: always
+            returned: always
             type: dict
             sample: {
             "domain_name_label": "ansible-b57dc95985712e45eb8b9c2e",
@@ -134,49 +134,49 @@
         etag:
             description:
                 - A unique read-only string that changes whenever the resource is updated.
-            returns: always
+            returned: always
             type: str
             sample: "W/'1905ee13-7623-45b1-bc6b-4a12b2fb9d15'"
         idle_timeout_in_minutes:
             description:
                 - The idle timeout of the public IP address.
-            returns: always
+            returned: always
             type: int
             sample: 4
         ip_address:
             description:
                 - The Public IP Prefix this Public IP Address should be allocated from.
-            returns: always
+            returned: always
             type: str
             sample: 52.160.103.93
         location:
             description:
                 - Resource location.
-            returns: always
+            returned: always
             type: str
             example: eastus
         name:
             description:
                 - Name of the Public IP Address.
-            returns: always
+            returned: always
             type: str
             example: publicip002
         provisioning_state:
             description:
                 - The provisioning state of the Public IP resource.
-            returns: always
+            returned: always
             type: str
             example: Succeeded
         public_ip_allocation_method:
              description:
                  - The public IP allocation method.
-             returns: always
+             returned: always
              type: str
              sample: static
         public_ip_address_version:
              description:
                  - The public IP address version.
-             returns: always
+             returned: always
              type: str
              sample: ipv4
         sku:
@@ -188,7 +188,7 @@
         tags:
             description:
                 - The resource tags.
-            returns: always
+            returned: always
             type: dict
             sample: {
                 "delete": "on-exit",
@@ -197,7 +197,7 @@
         type:
             description:
                 - Type of the resource.
-            returns: always
+            returned: always
             type: str
             sample: "Microsoft.Network/publicIPAddresses"
 '''

diff --git a/tests/sanity/ignore-2.10.txt b/tests/sanity/ignore-2.10.txt
@@ -96,7 +96,6 @@ plugins/modules/azure_rm_networkinterface_info.py validate-modules:return-syntax
 plugins/modules/azure_rm_publicipaddress.py validate-modules:parameter-type-not-in-doc
 plugins/modules/azure_rm_publicipaddress.py validate-modules:doc-elements-mismatch
 plugins/modules/azure_rm_publicipaddress.py validate-modules:doc-required-mismatch
-plugins/modules/azure_rm_publicipaddress.py validate-modules:return-syntax-error
 plugins/modules/azure_rm_publicipaddress_info.py validate-modules:parameter-type-not-in-doc
 plugins/modules/azure_rm_publicipaddress_info.py validate-modules:parameter-list-no-elements
 plugins/modules/azure_rm_resource.py validate-modules:parameter-type-not-in-doc

diff --git a/tests/sanity/ignore-2.11.txt b/tests/sanity/ignore-2.11.txt
@@ -96,7 +96,6 @@ plugins/modules/azure_rm_networkinterface_info.py validate-modules:return-syntax
 plugins/modules/azure_rm_publicipaddress.py validate-modules:parameter-type-not-in-doc
 plugins/modules/azure_rm_publicipaddress.py validate-modules:doc-elements-mismatch
 plugins/modules/azure_rm_publicipaddress.py validate-modules:doc-required-mismatch
-plugins/modules/azure_rm_publicipaddress.py validate-modules:return-syntax-error
 plugins/modules/azure_rm_publicipaddress_info.py validate-modules:parameter-type-not-in-doc
 plugins/modules/azure_rm_publicipaddress_info.py validate-modules:parameter-list-no-elements
 plugins/modules/azure_rm_resource.py validate-modules:parameter-type-not-in-doc

diff --git a/tests/sanity/ignore-2.12.txt b/tests/sanity/ignore-2.12.txt
@@ -96,7 +96,6 @@ plugins/modules/azure_rm_networkinterface_info.py validate-modules:return-syntax
 plugins/modules/azure_rm_publicipaddress.py validate-modules:parameter-type-not-in-doc
 plugins/modules/azure_rm_publicipaddress.py validate-modules:doc-elements-mismatch
 plugins/modules/azure_rm_publicipaddress.py validate-modules:doc-required-mismatch
-plugins/modules/azure_rm_publicipaddress.py validate-modules:return-syntax-error
 plugins/modules/azure_rm_publicipaddress_info.py validate-modules:parameter-type-not-in-doc
 plugins/modules/azure_rm_publicipaddress_info.py validate-modules:parameter-list-no-elements
 plugins/modules/azure_rm_resource.py validate-modules:parameter-type-not-in-doc

diff --git a/tests/sanity/ignore-2.13.txt b/tests/sanity/ignore-2.13.txt
@@ -95,7 +95,6 @@ plugins/modules/azure_rm_networkinterface_info.py validate-modules:return-syntax
 plugins/modules/azure_rm_publicipaddress.py validate-modules:parameter-type-not-in-doc
 plugins/modules/azure_rm_publicipaddress.py validate-modules:doc-elements-mismatch
 plugins/modules/azure_rm_publicipaddress.py validate-modules:doc-required-mismatch
-plugins/modules/azure_rm_publicipaddress.py validate-modules:return-syntax-error
 plugins/modules/azure_rm_publicipaddress_info.py validate-modules:parameter-type-not-in-doc
 plugins/modules/azure_rm_publicipaddress_info.py validate-modules:parameter-list-no-elements
 plugins/modules/azure_rm_resource.py validate-modules:parameter-type-not-in-doc

diff --git a/tests/sanity/ignore-2.14.txt b/tests/sanity/ignore-2.14.txt
@@ -95,7 +95,6 @@ plugins/modules/azure_rm_networkinterface_info.py validate-modules:return-syntax
 plugins/modules/azure_rm_publicipaddress.py validate-modules:parameter-type-not-in-doc
 plugins/modules/azure_rm_publicipaddress.py validate-modules:doc-elements-mismatch
 plugins/modules/azure_rm_publicipaddress.py validate-modules:doc-required-mismatch
-plugins/modules/azure_rm_publicipaddress.py validate-modules:return-syntax-error
 plugins/modules/azure_rm_publicipaddress_info.py validate-modules:parameter-type-not-in-doc
 plugins/modules/azure_rm_publicipaddress_info.py validate-modules:parameter-list-no-elements
 plugins/modules/azure_rm_resource.py validate-modules:parameter-type-not-in-doc