mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-25 11:51:26 -07: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:
parent
58eb2e849d
commit
cdd21e2170
624 changed files with 1458 additions and 9114 deletions
|
@ -31,32 +31,24 @@ options:
|
|||
validate_certs:
|
||||
description:
|
||||
- When using https if SSL certificate needs to be verified.
|
||||
required: false
|
||||
default: true
|
||||
type: bool
|
||||
default: 'yes'
|
||||
aliases:
|
||||
- verify_ssl
|
||||
login_user:
|
||||
description:
|
||||
- Gitlab user name.
|
||||
required: false
|
||||
default: null
|
||||
login_password:
|
||||
description:
|
||||
- Gitlab password for login_user
|
||||
required: false
|
||||
default: null
|
||||
login_token:
|
||||
description:
|
||||
- Gitlab token for logging in.
|
||||
required: false
|
||||
default: null
|
||||
group:
|
||||
description:
|
||||
- The name of the group of which this projects belongs to.
|
||||
- When not provided, project will belong to user which is configured in 'login_user' or 'login_token'
|
||||
- When provided with username, project will be created for this user. 'login_user' or 'login_token' needs admin rights.
|
||||
required: false
|
||||
default: null
|
||||
name:
|
||||
description:
|
||||
- The name of the project
|
||||
|
@ -65,63 +57,57 @@ options:
|
|||
description:
|
||||
- The path of the project you want to create, this will be server_url/<group>/path
|
||||
- If not supplied, name will be used.
|
||||
required: false
|
||||
default: null
|
||||
description:
|
||||
description:
|
||||
- An description for the project.
|
||||
required: false
|
||||
default: null
|
||||
issues_enabled:
|
||||
description:
|
||||
- Whether you want to create issues or not.
|
||||
- Possible values are true and false.
|
||||
required: false
|
||||
default: true
|
||||
type: bool
|
||||
default: 'yes'
|
||||
merge_requests_enabled:
|
||||
description:
|
||||
- If merge requests can be made or not.
|
||||
- Possible values are true and false.
|
||||
required: false
|
||||
default: true
|
||||
type: bool
|
||||
default: 'yes'
|
||||
wiki_enabled:
|
||||
description:
|
||||
- If an wiki for this project should be available or not.
|
||||
- Possible values are true and false.
|
||||
required: false
|
||||
default: true
|
||||
type: bool
|
||||
default: 'yes'
|
||||
snippets_enabled:
|
||||
description:
|
||||
- If creating snippets should be available or not.
|
||||
- Possible values are true and false.
|
||||
required: false
|
||||
default: true
|
||||
type: bool
|
||||
default: 'yes'
|
||||
public:
|
||||
description:
|
||||
- If the project is public available or not.
|
||||
- Setting this to true is same as setting visibility_level to 20.
|
||||
- Possible values are true and false.
|
||||
required: false
|
||||
default: false
|
||||
type: bool
|
||||
default: 'no'
|
||||
visibility_level:
|
||||
description:
|
||||
- Private. visibility_level is 0. Project access must be granted explicitly for each user.
|
||||
- Internal. visibility_level is 10. The project can be cloned by any logged in user.
|
||||
- Public. visibility_level is 20. The project can be cloned without any authentication.
|
||||
- Possible values are 0, 10 and 20.
|
||||
required: false
|
||||
default: 0
|
||||
import_url:
|
||||
description:
|
||||
- Git repository which will be imported into gitlab.
|
||||
- Gitlab server needs read access to this git repository.
|
||||
required: false
|
||||
default: false
|
||||
type: bool
|
||||
default: 'no'
|
||||
state:
|
||||
description:
|
||||
- create or delete project.
|
||||
- Possible values are present and absent.
|
||||
required: false
|
||||
default: "present"
|
||||
choices: ["present", "absent"]
|
||||
'''
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue