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
parent 58eb2e849d
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

@ -30,144 +30,78 @@ options:
state:
description:
- A value of present sets the quota and a value of absent resets the quota to system defaults.
required: False
default: present
backup_gigabytes:
required: False
default: None
description: Maximum size of backups in GB's.
backups:
required: False
default: None
description: Maximum number of backups allowed.
cores:
required: False
default: None
description: Maximum number of CPU's per project.
fixed_ips:
required: False
default: None
description: Number of fixed IP's to allow.
floating_ips:
required: False
default: None
description: Number of floating IP's to allow in Compute.
aliases: ['compute_floating_ips']
floatingip:
required: False
default: None
description: Number of floating IP's to allow in Network.
aliases: ['network_floating_ips']
gigabytes:
required: False
default: None
description: Maximum volume storage allowed for project.
gigabytes_lvm:
required: False
default: None
description: Maximum size in GB's of individual lvm volumes.
injected_file_size:
required: False
default: None
description: Maximum file size in bytes.
injected_files:
required: False
default: None
description: Number of injected files to allow.
injected_path_size:
required: False
default: None
description: Maximum path size.
instances:
required: False
default: None
description: Maximum number of instances allowed.
key_pairs:
required: False
default: None
description: Number of key pairs to allow.
loadbalancer:
required: False
default: None
description: Number of load balancers to allow.
version_added: "2.4"
network:
required: False
default: None
description: Number of networks to allow.
per_volume_gigabytes:
required: False
default: None
description: Maximum size in GB's of individual volumes.
pool:
required: False
default: None
description: Number of load balancer pools to allow.
version_added: "2.4"
port:
required: False
default: None
description: Number of Network ports to allow, this needs to be greater than the instances limit.
properties:
required: False
default: None
description: Number of properties to allow.
ram:
required: False
default: None
description: Maximum amount of ram in MB to allow.
rbac_policy:
required: False
default: None
description: Number of policies to allow.
router:
required: False
default: None
description: Number of routers to allow.
security_group_rule:
required: False
default: None
description: Number of rules per security group to allow.
security_group:
required: False
default: None
description: Number of security groups to allow.
server_group_members:
required: False
default: None
description: Number of server group members to allow.
server_groups:
required: False
default: None
description: Number of server groups to allow.
snapshots:
required: False
default: None
description: Number of snapshots to allow.
snapshots_lvm:
required: False
default: None
description: Number of LVM snapshots to allow.
subnet:
required: False
default: None
description: Number of subnets to allow.
subnetpool:
required: False
default: None
description: Number of subnet pools to allow.
volumes:
required: False
default: None
description: Number of volumes to allow.
volumes_lvm:
required: False
default: None
description: Number of LVM volumes to allow.
availability_zone:
description:
- Ignored. Present for backwards compatibility
required: false
requirements: