mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-05-07 22:02:50 +00:00
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:
@@ -44,7 +44,6 @@ options:
|
||||
state:
|
||||
description:
|
||||
- Whether the application should exist
|
||||
required: false
|
||||
choices: ['present', 'absent']
|
||||
default: "present"
|
||||
|
||||
@@ -57,19 +56,18 @@ options:
|
||||
description:
|
||||
- Whether the app should restart with an C(autostart.cgi) script
|
||||
type: bool
|
||||
default: "no"
|
||||
default: 'no'
|
||||
|
||||
extra_info:
|
||||
description:
|
||||
- Any extra parameters required by the app
|
||||
required: false
|
||||
default: ''
|
||||
|
||||
port_open:
|
||||
description:
|
||||
- IF the port should be opened
|
||||
type: bool
|
||||
default: false
|
||||
default: 'no'
|
||||
|
||||
login_name:
|
||||
description:
|
||||
@@ -84,7 +82,7 @@ options:
|
||||
machine:
|
||||
description:
|
||||
- The machine name to use (optional for accounts with only one machine)
|
||||
default: false
|
||||
default: False
|
||||
|
||||
'''
|
||||
|
||||
|
||||
@@ -41,7 +41,6 @@ options:
|
||||
state:
|
||||
description:
|
||||
- Whether the database should exist
|
||||
required: false
|
||||
choices: ['present', 'absent']
|
||||
default: "present"
|
||||
|
||||
@@ -54,8 +53,6 @@ options:
|
||||
password:
|
||||
description:
|
||||
- The password for the new database user.
|
||||
required: false
|
||||
default: null
|
||||
|
||||
login_name:
|
||||
description:
|
||||
|
||||
@@ -41,14 +41,12 @@ options:
|
||||
state:
|
||||
description:
|
||||
- Whether the domain should exist
|
||||
required: false
|
||||
choices: ['present', 'absent']
|
||||
default: "present"
|
||||
|
||||
subdomains:
|
||||
description:
|
||||
- Any subdomains to create.
|
||||
required: false
|
||||
default: []
|
||||
|
||||
login_name:
|
||||
|
||||
@@ -39,12 +39,10 @@ options:
|
||||
description:
|
||||
- The password for the mailbox
|
||||
required: true
|
||||
default: null
|
||||
|
||||
state:
|
||||
description:
|
||||
- Whether the mailbox should exist
|
||||
required: false
|
||||
choices: ['present', 'absent']
|
||||
default: "present"
|
||||
|
||||
|
||||
@@ -41,7 +41,6 @@ options:
|
||||
state:
|
||||
description:
|
||||
- Whether the website should exist
|
||||
required: false
|
||||
choices: ['present', 'absent']
|
||||
default: "present"
|
||||
|
||||
@@ -54,18 +53,16 @@ options:
|
||||
description:
|
||||
- Whether or not to use HTTPS
|
||||
type: bool
|
||||
default: 'false'
|
||||
default: 'no'
|
||||
|
||||
site_apps:
|
||||
description:
|
||||
- A mapping of URLs to apps
|
||||
required: false
|
||||
default: []
|
||||
|
||||
subdomains:
|
||||
description:
|
||||
- A list of subdomains associated with this site.
|
||||
required: false
|
||||
default: []
|
||||
|
||||
login_name:
|
||||
|
||||
Reference in New Issue
Block a user