doc style adjustments: modules j*

This commit is contained in:
Alexei Znamensky 2025-07-16 19:18:52 +12:00
commit 002981f94c
10 changed files with 31 additions and 32 deletions

View file

@ -32,7 +32,7 @@ options:
cert_port: cert_port:
description: description:
- Port to connect to URL. - Port to connect to URL.
- This will be used to create server URL:PORT. - This is used to create server URL:PORT.
type: int type: int
default: 443 default: 443
cert_path: cert_path:
@ -98,8 +98,8 @@ options:
state: state:
description: description:
- Defines action which can be either certificate import or removal. - Defines action which can be either certificate import or removal.
- When state is present, the certificate will always idempotently be inserted into the keystore, even if there already - When O(state=present), the certificate is always inserted into the keystore, even if there already exists a cert alias
exists a cert alias that is different. that is different.
type: str type: str
choices: [absent, present] choices: [absent, present]
default: present default: present

View file

@ -24,8 +24,8 @@ options:
name: name:
description: description:
- Name of the certificate in the keystore. - Name of the certificate in the keystore.
- If the provided name does not exist in the keystore, the module will re-create the keystore. This behavior changed - If the provided name does not exist in the keystore, the module re-creates the keystore. This behavior changed in
in community.general 3.0.0, before that the module would fail when the name did not match. community.general 3.0.0, before that the module would fail when the name did not match.
type: str type: str
required: true required: true
certificate: certificate:
@ -62,7 +62,7 @@ options:
password: password:
description: description:
- Password that should be used to secure the keystore. - Password that should be used to secure the keystore.
- If the provided password fails to unlock the keystore, the module will re-create the keystore with the new passphrase. - If the provided password fails to unlock the keystore, the module re-creates the keystore with the new passphrase.
This behavior changed in community.general 3.0.0, before that the module would fail when the password did not match. This behavior changed in community.general 3.0.0, before that the module would fail when the password did not match.
type: str type: str
required: true required: true
@ -130,7 +130,7 @@ notes:
or with the P(ansible.builtin.file#lookup) lookup), while O(certificate_path) and O(private_key_path) require that the or with the P(ansible.builtin.file#lookup) lookup), while O(certificate_path) and O(private_key_path) require that the
files are available on the target host. files are available on the target host.
- By design, any change of a value of options O(keystore_type), O(name) or O(password), as well as changes of key or certificate - By design, any change of a value of options O(keystore_type), O(name) or O(password), as well as changes of key or certificate
materials will cause the existing O(dest) to be overwritten. materials causes the existing O(dest) to be overwritten.
""" """
EXAMPLES = r""" EXAMPLES = r"""

View file

@ -30,7 +30,7 @@ options:
build_number: build_number:
description: description:
- An integer which specifies a build of a job. - An integer which specifies a build of a job.
- If not specified the last build information will be returned. - If not specified the last build information is returned.
type: int type: int
password: password:
description: description:

View file

@ -10,13 +10,13 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
DOCUMENTATION = r""" DOCUMENTATION = r"""
---
module: jenkins_credential module: jenkins_credential
short_description: Manage Jenkins credentials and domains via API short_description: Manage Jenkins credentials and domains through API
version_added: 11.1.0 version_added: 11.1.0
description: description:
- This module allows managing Jenkins credentials and domain scopes via the Jenkins HTTP API. - This module allows managing Jenkins credentials and domain scopes through the Jenkins HTTP API.
- Create, update, and delete different credential types such as C(username/password), C(secret text), C(SSH key), C(certificates), C(GitHub App), and domains. - Create, update, and delete different credential types such as C(username/password), C(secret text), C(SSH key), C(certificates),
C(GitHub App), and domains.
- For scoped domains (O(type=scope)), it supports restrictions based on V(hostname), V(hostname:port), V(path), and V(scheme). - For scoped domains (O(type=scope)), it supports restrictions based on V(hostname), V(hostname:port), V(path), and V(scheme).
requirements: requirements:
- urllib3 >= 1.26.0 - urllib3 >= 1.26.0
@ -170,7 +170,7 @@ options:
inc_path: inc_path:
description: description:
- List of URL paths to include when matching credentials to domains. - List of URL paths to include when matching credentials to domains.
- "B(Matching is hierarchical): subpaths of excluded paths are also excluded, even if explicitly included." - 'B(Matching is hierarchical): subpaths of excluded paths are also excluded, even if explicitly included.'
type: list type: list
elements: str elements: str
exc_path: exc_path:

View file

@ -76,8 +76,8 @@ options:
type: bool type: bool
default: true default: true
description: description:
- If set to V(false), the SSL certificates will not be validated. This should only set to V(false) used on personally - If set to V(false), the SSL certificates are not validated. This should only set to V(false) used on personally controlled
controlled sites using self-signed certificates as it avoids verifying the source site. sites using self-signed certificates as it avoids verifying the source site.
- The C(python-jenkins) library only handles this by using the environment variable E(PYTHONHTTPSVERIFY). - The C(python-jenkins) library only handles this by using the environment variable E(PYTHONHTTPSVERIFY).
version_added: 2.3.0 version_added: 2.3.0
""" """

View file

@ -53,7 +53,7 @@ options:
- User to authenticate with the Jenkins server. - User to authenticate with the Jenkins server.
validate_certs: validate_certs:
description: description:
- If set to V(false), the SSL certificates will not be validated. - If set to V(false), the SSL certificates are not validated.
- This should only set to V(false) used on personally controlled sites using self-signed certificates. - This should only set to V(false) used on personally controlled sites using self-signed certificates.
default: true default: true
type: bool type: bool

View file

@ -65,9 +65,9 @@ options:
offline_message: offline_message:
description: description:
- Specifies the offline reason message to be set when configuring the Jenkins node state. - Specifies the offline reason message to be set when configuring the Jenkins node state.
- If O(offline_message) is given and requested O(state) is not V(disabled), an error will be raised. - If O(offline_message) is given and requested O(state) is not V(disabled), an error is raised.
- Internally O(offline_message) is set using the V(toggleOffline) API, so updating the message when the node is already - Internally O(offline_message) is set using the V(toggleOffline) API, so updating the message when the node is already
offline (current state V(disabled)) is not possible. In this case, a warning will be issued. offline (current state V(disabled)) is not possible. In this case, a warning is issued.
type: str type: str
version_added: 10.0.0 version_added: 10.0.0
""" """

View file

@ -51,7 +51,7 @@ options:
type: str type: str
description: description:
- Desired plugin state. - Desired plugin state.
- If set to V(latest), the check for new version will be performed every time. This is suitable to keep the plugin up-to-date. - If set to V(latest), the check for new version is performed every time. This is suitable to keep the plugin up-to-date.
choices: [absent, present, pinned, unpinned, enabled, disabled, latest] choices: [absent, present, pinned, unpinned, enabled, disabled, latest]
default: present default: present
timeout: timeout:
@ -64,8 +64,8 @@ options:
description: description:
- Number of seconds after which a new copy of the C(update-center.json) file is downloaded. This is used to avoid the - Number of seconds after which a new copy of the C(update-center.json) file is downloaded. This is used to avoid the
need to download the plugin to calculate its checksum when O(state=latest) is specified. need to download the plugin to calculate its checksum when O(state=latest) is specified.
- Set it to V(0) if no cache file should be used. In that case, the plugin file will always be downloaded to calculate - Set it to V(0) if no cache file should be used. In that case, the plugin file is always downloaded to calculate its
its checksum when O(state=latest) is specified. checksum when O(state=latest) is specified.
default: 86400 default: 86400
updates_url: updates_url:
type: list type: list

View file

@ -39,8 +39,8 @@ options:
default: http://localhost:8080 default: http://localhost:8080
validate_certs: validate_certs:
description: description:
- If set to V(false), the SSL certificates will not be validated. This should only set to V(false) used on personally - If set to V(false), the SSL certificates are not validated. This should only set to V(false) used on personally controlled
controlled sites using self-signed certificates as it avoids verifying the source site. sites using self-signed certificates as it avoids verifying the source site.
type: bool type: bool
default: true default: true
user: user:

View file

@ -117,14 +117,13 @@ options:
suboptions: suboptions:
type: type:
description: description:
- Use type to specify which of the JIRA visibility restriction types will be used. - Use O(comment_visibility.type) to specify which of the JIRA visibility restriction types is used.
type: str type: str
required: true required: true
choices: [group, role] choices: [group, role]
value: value:
description: description:
- Use value to specify value corresponding to the type of visibility restriction. For example name of the group - Specify value corresponding to the type of visibility restriction. For example name of the group or role.
or role.
type: str type: str
required: true required: true
version_added: '3.2.0' version_added: '3.2.0'
@ -165,12 +164,12 @@ options:
type: str type: str
required: false required: false
description: description:
- Set issue from which link will be created. - Set issue from which link is created.
outwardissue: outwardissue:
type: str type: str
required: false required: false
description: description:
- Set issue to which link will be created. - Set issue to which link is created.
fields: fields:
type: dict type: dict
required: false required: false
@ -192,7 +191,7 @@ options:
maxresults: maxresults:
required: false required: false
description: description:
- Limit the result of O(operation=search). If no value is specified, the default jira limit will be used. - Limit the result of O(operation=search). If no value is specified, the default JIRA limit is used.
- Used when O(operation=search) only, ignored otherwise. - Used when O(operation=search) only, ignored otherwise.
type: int type: int
version_added: '0.2.0' version_added: '0.2.0'
@ -226,12 +225,12 @@ options:
content: content:
type: str type: str
description: description:
- The Base64 encoded contents of the file to attach. If not specified, the contents of O(attachment.filename) will - The Base64 encoded contents of the file to attach. If not specified, the contents of O(attachment.filename) is
be used instead. used instead.
mimetype: mimetype:
type: str type: str
description: description:
- The MIME type to supply for the upload. If not specified, best-effort detection will be done. - The MIME type to supply for the upload. If not specified, best-effort detection is performed.
notes: notes:
- Currently this only works with basic-auth, or tokens. - Currently this only works with basic-auth, or tokens.
- To use with JIRA Cloud, pass the login e-mail as the O(username) and the API token as O(password). - To use with JIRA Cloud, pass the login e-mail as the O(username) and the API token as O(password).