1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

Change type str -> path in argspec. (#1741)

This commit is contained in:
Felix Fontein 2021-02-12 07:58:30 +01:00 committed by GitHub
parent ba4a98b1be
commit f12df1d21b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 14 additions and 10 deletions

View file

@ -0,0 +1,4 @@
minor_changes:
- "oci_vcn - ``api_user_key_file`` is now of type ``path`` and no longer ``str``. A side effect is that certain expansions are made, like ``~`` is replaced by the user's home directory, and environment variables like ``$HOME`` or ``$TEMP`` are evaluated (https://github.com/ansible-collections/community.general/pull/1741)."
- "lxd_container - ``client_key`` and ``client_cert`` are now of type ``path`` and no longer ``str``. A side effect is that certain expansions are made, like ``~`` is replaced by the user's home directory, and environment variables like ``$HOME`` or ``$TEMP`` are evaluated (https://github.com/ansible-collections/community.general/pull/1741)."
- "lxd_profile - ``client_key`` and ``client_cert`` are now of type ``path`` and no longer ``str``. A side effect is that certain expansions are made, like ``~`` is replaced by the user's home directory, and environment variables like ``$HOME`` or ``$TEMP`` are evaluated (https://github.com/ansible-collections/community.general/pull/1741)."

View file

@ -47,7 +47,7 @@ class ModuleDocFragment(object):
OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is
not specified through a configuration file (See C(config_file_location)). If the key is encrypted not specified through a configuration file (See C(config_file_location)). If the key is encrypted
with a pass-phrase, the C(api_user_key_pass_phrase) option must also be provided. with a pass-phrase, the C(api_user_key_pass_phrase) option must also be provided.
type: str type: path
api_user_key_pass_phrase: api_user_key_pass_phrase:
description: description:
- Passphrase used by the key referenced in C(api_user_key_file), if it is encrypted. If not set, then - Passphrase used by the key referenced in C(api_user_key_file), if it is encrypted. If not set, then

View file

@ -90,7 +90,7 @@ def get_common_arg_spec(supports_create=False, supports_wait=False):
config_profile_name=dict(type="str", default="DEFAULT"), config_profile_name=dict(type="str", default="DEFAULT"),
api_user=dict(type="str"), api_user=dict(type="str"),
api_user_fingerprint=dict(type="str", no_log=True), api_user_fingerprint=dict(type="str", no_log=True),
api_user_key_file=dict(type="str"), api_user_key_file=dict(type="path"),
api_user_key_pass_phrase=dict(type="str", no_log=True), api_user_key_pass_phrase=dict(type="str", no_log=True),
auth_type=dict( auth_type=dict(
type="str", type="str",

View file

@ -132,14 +132,14 @@ options:
- If not specified, it defaults to C(${HOME}/.config/lxc/client.key). - If not specified, it defaults to C(${HOME}/.config/lxc/client.key).
required: false required: false
aliases: [ key_file ] aliases: [ key_file ]
type: str type: path
client_cert: client_cert:
description: description:
- The client certificate file path. - The client certificate file path.
- If not specified, it defaults to C(${HOME}/.config/lxc/client.crt). - If not specified, it defaults to C(${HOME}/.config/lxc/client.crt).
required: false required: false
aliases: [ cert_file ] aliases: [ cert_file ]
type: str type: path
trust_password: trust_password:
description: description:
- The client trusted password. - The client trusted password.
@ -690,11 +690,11 @@ def main():
default='unix:/var/snap/lxd/common/lxd/unix.socket' default='unix:/var/snap/lxd/common/lxd/unix.socket'
), ),
client_key=dict( client_key=dict(
type='str', type='path',
aliases=['key_file'] aliases=['key_file']
), ),
client_cert=dict( client_cert=dict(
type='str', type='path',
aliases=['cert_file'] aliases=['cert_file']
), ),
trust_password=dict(type='str', no_log=True) trust_password=dict(type='str', no_log=True)

View file

@ -79,14 +79,14 @@ options:
- If not specified, it defaults to C($HOME/.config/lxc/client.key). - If not specified, it defaults to C($HOME/.config/lxc/client.key).
required: false required: false
aliases: [ key_file ] aliases: [ key_file ]
type: str type: path
client_cert: client_cert:
description: description:
- The client certificate file path. - The client certificate file path.
- If not specified, it defaults to C($HOME/.config/lxc/client.crt). - If not specified, it defaults to C($HOME/.config/lxc/client.crt).
required: false required: false
aliases: [ cert_file ] aliases: [ cert_file ]
type: str type: path
trust_password: trust_password:
description: description:
- The client trusted password. - The client trusted password.
@ -384,11 +384,11 @@ def main():
default='unix:/var/snap/lxd/common/lxd/unix.socket' default='unix:/var/snap/lxd/common/lxd/unix.socket'
), ),
client_key=dict( client_key=dict(
type='str', type='path',
aliases=['key_file'] aliases=['key_file']
), ),
client_cert=dict( client_cert=dict(
type='str', type='path',
aliases=['cert_file'] aliases=['cert_file']
), ),
trust_password=dict(type='str', no_log=True) trust_password=dict(type='str', no_log=True)