Clean up module documentation (#36909)

* Clean up module documentation

This PR includes:
- Removal of `default: None` (and variations)
- Removal of `required: false`
- Fixing booleans and `type: bool` where required

* Fix remaining (new) validation issues
This commit is contained in:
Dag Wieers 2018-03-15 22:15:24 +01:00 committed by GitHub
commit cdd21e2170
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
624 changed files with 1458 additions and 9114 deletions

View file

@ -22,27 +22,27 @@ extends_documentation_fragment:
- netapp.eseries
options:
state:
required: true
description:
- Whether the specified volume should exist or not.
required: true
choices: ['present', 'absent']
name:
required: true
description:
- The name of the volume to manage
storage_pool_name:
required: true
storage_pool_name:
description:
- "Required only when requested state is 'present'. The name of the storage pool the volume should exist on."
required: true
size_unit:
description:
- The unit used to interpret the size parameter
choices: ['bytes', 'b', 'kb', 'mb', 'gb', 'tb', 'pb', 'eb', 'zb', 'yb']
default: 'gb'
size:
required: true
description:
- "Required only when state = 'present'. The size of the volume in (size_unit)."
required: true
segment_size_kb:
description:
- The segment size of the new volume
@ -50,8 +50,8 @@ options:
thin_provision:
description:
- Whether the volume should be thin provisioned. Thin volumes can only be created on disk pools (raidDiskPool).
default: False
choices: ['yes','no','true','false']
type: bool
default: 'no'
thin_volume_repo_size:
description:
- Initial size of the thin volume repository volume (in size_unit)
@ -63,12 +63,13 @@ options:
ssd_cache_enabled:
description:
- Whether an existing SSD cache should be enabled on the volume (fails if no SSD cache defined)
default: None (ignores existing SSD cache setting)
choices: ['yes','no','true','false']
- The default value is to ignore existing SSD cache setting.
type: bool
data_assurance_enabled:
description:
- If data assurance should be enabled for the volume
default: false
type: bool
default: 'no'
# TODO: doc thin volume parameters