mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-05-08 14:22:46 +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:
@@ -30,41 +30,32 @@ options:
|
||||
- The groovy script to be executed.
|
||||
This gets passed as a string Template if args is defined.
|
||||
required: true
|
||||
default: null
|
||||
url:
|
||||
description:
|
||||
- The jenkins server to execute the script against. The default is a local
|
||||
jenkins instance that is not being proxied through a webserver.
|
||||
required: false
|
||||
default: http://localhost:8080
|
||||
validate_certs:
|
||||
description:
|
||||
- If set to C(no), the SSL certificates will not be validated.
|
||||
This should only set to C(no) used on personally controlled sites
|
||||
using self-signed certificates as it avoids verifying the source site.
|
||||
required: false
|
||||
default: True
|
||||
type: bool
|
||||
default: 'yes'
|
||||
user:
|
||||
description:
|
||||
- The username to connect to the jenkins server with.
|
||||
required: false
|
||||
default: null
|
||||
password:
|
||||
description:
|
||||
- The password to connect to the jenkins server with.
|
||||
required: false
|
||||
default: null
|
||||
timeout:
|
||||
description:
|
||||
- The request timeout in seconds
|
||||
required: false
|
||||
default: 10
|
||||
version_added: "2.4"
|
||||
args:
|
||||
description:
|
||||
- A dict of key-value pairs used in formatting the script using string.Template (see https://docs.python.org/2/library/string.html#template-strings).
|
||||
required: false
|
||||
default: null
|
||||
|
||||
notes:
|
||||
- Since the script can do anything this does not report on changes.
|
||||
|
||||
Reference in New Issue
Block a user