ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-26 22:51:23 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

docs_fragments formatting and typo improvements (#17981)

Browse source
This commit is contained in:
John R Barker 2016-10-14 15:13:15 +01:00 • committed by GitHub
commit 9183bb6391
18 changed files with 133 additions and 136 deletions
Download patch file Download diff file Expand all files Collapse all files

40
lib/ansible/utils/module_docs_fragments/rackspace.py
View file

@ -23,31 +23,31 @@ class ModuleDocFragment(object):
options:
api_key:
description:
- Rackspace API key (overrides I(credentials))
- Rackspace API key, overrides I(credentials).
aliases:
- password
credentials:
description:
- File to find the Rackspace credentials in (ignored if I(api_key) and
I(username) are provided)
- File to find the Rackspace credentials in. Ignored if I(api_key) and
I(username) are provided.
default: null
aliases:
- creds_file
env:
description:
- Environment as configured in ~/.pyrax.cfg,
see U(https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration)
- Environment as configured in I(~/.pyrax.cfg),
see U(https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration).
version_added: 1.5
region:
description:
- Region to create an instance in
- Region to create an instance in.
default: DFW
username:
description:
- Rackspace username (overrides I(credentials))
- Rackspace username, overrides I(credentials).
verify_ssl:
description:
- Whether or not to require SSL validation of API endpoints
- Whether or not to require SSL validation of API endpoints.
version_added: 1.5
requirements:
- "python >= 2.6"
@ -67,49 +67,49 @@ notes:
options:
api_key:
description:
- Rackspace API key (overrides I(credentials))
- Rackspace API key, overrides I(credentials).
aliases:
- password
auth_endpoint:
description:
- The URI of the authentication service
- The URI of the authentication service.
default: https://identity.api.rackspacecloud.com/v2.0/
version_added: 1.5
credentials:
description:
- File to find the Rackspace credentials in (ignored if I(api_key) and
I(username) are provided)
- File to find the Rackspace credentials in. Ignored if I(api_key) and
I(username) are provided.
default: null
aliases:
- creds_file
env:
description:
- Environment as configured in ~/.pyrax.cfg,
see U(https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration)
- Environment as configured in I(~/.pyrax.cfg),
see U(https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration).
version_added: 1.5
identity_type:
description:
- Authentication machanism to use, such as rackspace or keystone
- Authentication mechanism to use, such as rackspace or keystone.
default: rackspace
version_added: 1.5
region:
description:
- Region to create an instance in
- Region to create an instance in.
default: DFW
tenant_id:
description:
- The tenant ID used for authentication
- The tenant ID used for authentication.
version_added: 1.5
tenant_name:
description:
- The tenant name used for authentication
- The tenant name used for authentication.
version_added: 1.5
username:
description:
- Rackspace username (overrides I(credentials))
- Rackspace username, overrides I(credentials).
verify_ssl:
description:
- Whether or not to require SSL validation of API endpoints
- Whether or not to require SSL validation of API endpoints.
version_added: 1.5
requirements:
- "python >= 2.6"