mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-05-08 06:12:51 +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:
@@ -27,42 +27,30 @@ options:
|
||||
- The name will be taken as group name when it ends with a colon I(:)
|
||||
- Group support is only available in Ansible version 1.6 or later.
|
||||
required: true
|
||||
default: null
|
||||
config:
|
||||
description:
|
||||
- The supervisor configuration file path
|
||||
required: false
|
||||
default: null
|
||||
version_added: "1.3"
|
||||
server_url:
|
||||
description:
|
||||
- URL on which supervisord server is listening
|
||||
required: false
|
||||
default: null
|
||||
version_added: "1.3"
|
||||
username:
|
||||
description:
|
||||
- username to use for authentication
|
||||
required: false
|
||||
default: null
|
||||
version_added: "1.3"
|
||||
password:
|
||||
description:
|
||||
- password to use for authentication
|
||||
required: false
|
||||
default: null
|
||||
version_added: "1.3"
|
||||
state:
|
||||
description:
|
||||
- The desired state of program/group.
|
||||
required: true
|
||||
default: null
|
||||
choices: [ "present", "started", "stopped", "restarted", "absent" ]
|
||||
supervisorctl_path:
|
||||
description:
|
||||
- path to supervisorctl executable
|
||||
required: false
|
||||
default: null
|
||||
version_added: "1.4"
|
||||
notes:
|
||||
- When C(state) = I(present), the module will call C(supervisorctl reread) then C(supervisorctl add) if the program/group does not exist.
|
||||
|
||||
Reference in New Issue
Block a user