Add missing types and requires (#29)

The cdi_upload module is missing these in the documentation. This commit adds them.
ansible-collections · Sep 14, 2021 · 3414a94 · 3414a94
1 parent 73a1f74
commit 3414a94
Show file tree

Hide file tree

Showing 6 changed files with 7 additions and 11 deletions.
diff --git a/plugins/modules/kubevirt_cdi_upload.py b/plugins/modules/kubevirt_cdi_upload.py
@@ -28,14 +28,18 @@
     description:
       - Use to specify the name of the target PersistentVolumeClaim.
     required: true
+    type: str
   pvc_namespace:
     description:
       - Use to specify the namespace of the target PersistentVolumeClaim.
     required: true
+    type: str
   upload_host:
     description:
       - URL containing the host and port on which the CDI Upload Proxy is available.
       - "More info: U(https://github.com/kubevirt/containerized-data-importer/blob/master/doc/upload.md#expose-cdi-uploadproxy-service)"
+    required: true
+    type: str
   upload_host_validate_certs:
     description:
       - Whether or not to verify the CDI Upload Proxy's SSL certificates against your system's CA trust store.
@@ -45,6 +49,8 @@
   path:
     description:
       - Path of local image file to transfer.
+    required: true
+    type: str
   merge_type:
     description:
       - Whether to override the default patch merge approach with a specific type. By default, the strategic

diff --git a/plugins/modules/kubevirt_pvc.py b/plugins/modules/kubevirt_pvc.py
@@ -43,6 +43,7 @@
     choices:
     - present
     - absent
+    type: str
   force:
     description:
     - If set to C(True), and I(state) is C(present), an existing object will be replaced.

diff --git a/tests/sanity/ignore-2.10.txt b/tests/sanity/ignore-2.10.txt
@@ -1,13 +1,10 @@
-plugins/modules/kubevirt_cdi_upload.py validate-modules:doc-missing-type
-plugins/modules/kubevirt_cdi_upload.py validate-modules:doc-required-mismatch
 plugins/modules/kubevirt_cdi_upload.py validate-modules:mutually_exclusive-unknown
 plugins/modules/kubevirt_cdi_upload.py validate-modules:parameter-list-no-elements
 plugins/modules/kubevirt_preset.py validate-modules:mutually_exclusive-unknown
 plugins/modules/kubevirt_preset.py validate-modules:parameter-list-no-elements
 plugins/modules/kubevirt_preset.py validate-modules:parameter-type-not-in-doc
 plugins/modules/kubevirt_pvc.py validate-modules:mutually_exclusive-unknown
 plugins/modules/kubevirt_pvc.py validate-modules:parameter-list-no-elements
-plugins/modules/kubevirt_pvc.py validate-modules:parameter-type-not-in-doc
 plugins/modules/kubevirt_pvc.py validate-modules:return-syntax-error
 plugins/modules/kubevirt_rs.py validate-modules:doc-required-mismatch
 plugins/modules/kubevirt_rs.py validate-modules:mutually_exclusive-unknown

diff --git a/tests/sanity/ignore-2.11.txt b/tests/sanity/ignore-2.11.txt
@@ -1,13 +1,10 @@
-plugins/modules/kubevirt_cdi_upload.py validate-modules:doc-missing-type
-plugins/modules/kubevirt_cdi_upload.py validate-modules:doc-required-mismatch
 plugins/modules/kubevirt_cdi_upload.py validate-modules:mutually_exclusive-unknown
 plugins/modules/kubevirt_cdi_upload.py validate-modules:parameter-list-no-elements
 plugins/modules/kubevirt_preset.py validate-modules:mutually_exclusive-unknown
 plugins/modules/kubevirt_preset.py validate-modules:parameter-list-no-elements
 plugins/modules/kubevirt_preset.py validate-modules:parameter-type-not-in-doc
 plugins/modules/kubevirt_pvc.py validate-modules:mutually_exclusive-unknown
 plugins/modules/kubevirt_pvc.py validate-modules:parameter-list-no-elements
-plugins/modules/kubevirt_pvc.py validate-modules:parameter-type-not-in-doc
 plugins/modules/kubevirt_pvc.py validate-modules:return-syntax-error
 plugins/modules/kubevirt_rs.py validate-modules:doc-required-mismatch
 plugins/modules/kubevirt_rs.py validate-modules:mutually_exclusive-unknown

diff --git a/tests/sanity/ignore-2.12.txt b/tests/sanity/ignore-2.12.txt
@@ -1,13 +1,10 @@
-plugins/modules/kubevirt_cdi_upload.py validate-modules:doc-missing-type
-plugins/modules/kubevirt_cdi_upload.py validate-modules:doc-required-mismatch
 plugins/modules/kubevirt_cdi_upload.py validate-modules:mutually_exclusive-unknown
 plugins/modules/kubevirt_cdi_upload.py validate-modules:parameter-list-no-elements
 plugins/modules/kubevirt_preset.py validate-modules:mutually_exclusive-unknown
 plugins/modules/kubevirt_preset.py validate-modules:parameter-list-no-elements
 plugins/modules/kubevirt_preset.py validate-modules:parameter-type-not-in-doc
 plugins/modules/kubevirt_pvc.py validate-modules:mutually_exclusive-unknown
 plugins/modules/kubevirt_pvc.py validate-modules:parameter-list-no-elements
-plugins/modules/kubevirt_pvc.py validate-modules:parameter-type-not-in-doc
 plugins/modules/kubevirt_pvc.py validate-modules:return-syntax-error
 plugins/modules/kubevirt_rs.py validate-modules:doc-required-mismatch
 plugins/modules/kubevirt_rs.py validate-modules:mutually_exclusive-unknown

diff --git a/tests/sanity/ignore-2.9.txt b/tests/sanity/ignore-2.9.txt
@@ -1,5 +1,3 @@
-plugins/modules/kubevirt_cdi_upload.py validate-modules:doc-missing-type
 plugins/modules/kubevirt_preset.py validate-modules:parameter-type-not-in-doc
-plugins/modules/kubevirt_pvc.py validate-modules:parameter-type-not-in-doc
 plugins/modules/kubevirt_rs.py validate-modules:parameter-type-not-in-doc
 plugins/modules/kubevirt_vm.py validate-modules:parameter-type-not-in-doc