From aeb0e78148b04f735a2fceeeb9fb6cee90267717 Mon Sep 17 00:00:00 2001 From: Mark Chappell Date: Mon, 16 Mar 2020 13:34:53 +0100 Subject: [PATCH] Clean up doc-required-mismatch Change-Id: Ia1449c50295f6b3551f176edf9bd439ace65ec90 --- plugins/modules/os_coe_cluster_template.py | 2 ++ plugins/modules/os_group_info.py | 1 - plugins/modules/os_ironic.py | 3 ++- plugins/modules/os_nova_flavor.py | 2 +- plugins/modules/os_port.py | 2 +- plugins/modules/os_project_access.py | 2 ++ plugins/modules/os_project_info.py | 1 - plugins/modules/os_recordset.py | 6 +++--- plugins/modules/os_server.py | 2 +- plugins/modules/os_server_action.py | 2 +- plugins/modules/os_user_info.py | 1 - tests/sanity/ignore-2.10.txt | 11 ----------- 12 files changed, 13 insertions(+), 22 deletions(-) diff --git a/plugins/modules/os_coe_cluster_template.py b/plugins/modules/os_coe_cluster_template.py index 2ef2c67c..4eb196b2 100644 --- a/plugins/modules/os_coe_cluster_template.py +++ b/plugins/modules/os_coe_cluster_template.py @@ -23,6 +23,7 @@ options: - The Container Orchestration Engine for this clustertemplate choices: [kubernetes, swarm, mesos] type: str + required: true dns_nameserver: description: - The DNS nameserver address @@ -66,6 +67,7 @@ options: description: - Image id the cluster will be based on type: str + required: true labels: description: - One or more key/value pairs diff --git a/plugins/modules/os_group_info.py b/plugins/modules/os_group_info.py index e4785699..09e0567b 100644 --- a/plugins/modules/os_group_info.py +++ b/plugins/modules/os_group_info.py @@ -20,7 +20,6 @@ options: name: description: - Name or ID of the group. - required: true type: str domain: description: diff --git a/plugins/modules/os_ironic.py b/plugins/modules/os_ironic.py index 84cb6a55..e88db9e3 100644 --- a/plugins/modules/os_ironic.py +++ b/plugins/modules/os_ironic.py @@ -37,7 +37,7 @@ options: driver: description: - The name of the Ironic Driver to use with this node. - required: true + - Required when I(state=present) type: str chassis_uuid: description: @@ -54,6 +54,7 @@ options: - Information for this server's driver. Will vary based on which driver is in use. Any sub-field which is populated will be validated during creation. + required: true type: dict suboptions: power: diff --git a/plugins/modules/os_nova_flavor.py b/plugins/modules/os_nova_flavor.py index 86fe5b1a..d6fbb47a 100644 --- a/plugins/modules/os_nova_flavor.py +++ b/plugins/modules/os_nova_flavor.py @@ -185,7 +185,7 @@ def main(): argument_spec = openstack_full_argument_spec( state=dict(required=False, default='present', choices=['absent', 'present']), - name=dict(required=False), + name=dict(required=True), # required when state is 'present' ram=dict(required=False, type='int'), diff --git a/plugins/modules/os_port.py b/plugins/modules/os_port.py index 76f26d3d..f2df702c 100644 --- a/plugins/modules/os_port.py +++ b/plugins/modules/os_port.py @@ -21,7 +21,7 @@ options: network: description: - Network ID or name this port belongs to. - required: true + - Required when creating a new port. type: str name: description: diff --git a/plugins/modules/os_project_access.py b/plugins/modules/os_project_access.py index 95a92001..8d62cbd8 100644 --- a/plugins/modules/os_project_access.py +++ b/plugins/modules/os_project_access.py @@ -41,10 +41,12 @@ options: resource_type: description: - The resource type (eg. nova_flavor, cinder_volume_type). + required: true type: str resource_name: description: - The resource name (eg. tiny). + required: true type: str requirements: - "python >= 3.6" diff --git a/plugins/modules/os_project_info.py b/plugins/modules/os_project_info.py index 1beab135..e0b6ddd6 100644 --- a/plugins/modules/os_project_info.py +++ b/plugins/modules/os_project_info.py @@ -21,7 +21,6 @@ options: name: description: - Name or ID of the project - required: true type: str domain: description: diff --git a/plugins/modules/os_recordset.py b/plugins/modules/os_recordset.py index 6faf90c4..19ff1b90 100644 --- a/plugins/modules/os_recordset.py +++ b/plugins/modules/os_recordset.py @@ -31,12 +31,12 @@ options: recordset_type: description: - Recordset type - required: true + - Required when I(state=present). type: str records: description: - - List of recordset definitions - required: true + - List of recordset definitions. + - Required when I(state=present). type: list description: description: diff --git a/plugins/modules/os_server.py b/plugins/modules/os_server.py index 321512ef..77d6c4c6 100644 --- a/plugins/modules/os_server.py +++ b/plugins/modules/os_server.py @@ -31,7 +31,7 @@ options: image: description: - The name or id of the base image to boot. - required: true + - Required when I(boot_from_volume=true) type: str image_exclude: description: diff --git a/plugins/modules/os_server_action.py b/plugins/modules/os_server_action.py index 732c0ef8..9c04b64e 100644 --- a/plugins/modules/os_server_action.py +++ b/plugins/modules/os_server_action.py @@ -42,8 +42,8 @@ options: changed as the servers API does not provide lock status. choices: [stop, start, pause, unpause, lock, unlock, suspend, resume, rebuild] - default: present type: str + required: true image: description: - Image the server should be rebuilt with diff --git a/plugins/modules/os_user_info.py b/plugins/modules/os_user_info.py index 0be7c08d..ead97c72 100644 --- a/plugins/modules/os_user_info.py +++ b/plugins/modules/os_user_info.py @@ -21,7 +21,6 @@ options: name: description: - Name or ID of the user - required: true type: str domain: description: diff --git a/tests/sanity/ignore-2.10.txt b/tests/sanity/ignore-2.10.txt index 491bddeb..a779d82a 100644 --- a/tests/sanity/ignore-2.10.txt +++ b/tests/sanity/ignore-2.10.txt @@ -1,25 +1,14 @@ plugins/module_utils/openstack.py future-import-boilerplate plugins/module_utils/openstack.py metaclass-boilerplate -plugins/modules/os_coe_cluster_template.py validate-modules:doc-required-mismatch -plugins/modules/os_group_info.py validate-modules:doc-required-mismatch plugins/modules/os_image.py validate-modules:doc-choices-do-not-match-spec plugins/modules/os_image.py validate-modules:doc-default-does-not-match-spec plugins/modules/os_ironic.py validate-modules:doc-choices-do-not-match-spec -plugins/modules/os_ironic.py validate-modules:doc-required-mismatch -plugins/modules/os_nova_flavor.py validate-modules:doc-required-mismatch -plugins/modules/os_port.py validate-modules:doc-required-mismatch -plugins/modules/os_project_access.py validate-modules:doc-required-mismatch -plugins/modules/os_project_info.py validate-modules:doc-required-mismatch plugins/modules/os_quota.py validate-modules:doc-choices-do-not-match-spec plugins/modules/os_quota.py validate-modules:return-syntax-error -plugins/modules/os_recordset.py validate-modules:doc-required-mismatch plugins/modules/os_server.py validate-modules:doc-default-does-not-match-spec -plugins/modules/os_server.py validate-modules:doc-required-mismatch plugins/modules/os_server_action.py validate-modules:doc-default-does-not-match-spec -plugins/modules/os_server_action.py validate-modules:doc-required-mismatch plugins/modules/os_stack.py validate-modules:doc-default-does-not-match-spec plugins/modules/os_subnet.py validate-modules:doc-choices-do-not-match-spec -plugins/modules/os_user_info.py validate-modules:doc-required-mismatch plugins/doc_fragments/openstack.py future-import-boilerplate plugins/doc_fragments/openstack.py metaclass-boilerplate tests/unit/mock/path.py future-import-boilerplate