Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix collection module docs for names, IDs, and named URLs #14269

Merged
merged 2 commits into from
Jul 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions awx_collection/plugins/modules/ad_hoc_command.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,12 @@
choices: [ 'run', 'check' ]
execution_environment:
description:
- Execution Environment to use for the ad hoc command.
- Execution Environment name, ID, or named URL to use for the ad hoc command.
required: False
type: str
inventory:
description:
- Inventory to use for the ad hoc command.
- Inventory name, ID, or named URL to use for the ad hoc command.
required: True
type: str
limit:
Expand All @@ -43,7 +43,7 @@
type: str
credential:
description:
- Credential to use for ad hoc command.
- Credential name, ID, or named URL to use for ad hoc command.
required: True
type: str
module_name:
Expand Down
2 changes: 1 addition & 1 deletion awx_collection/plugins/modules/application.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
required: False
organization:
description:
- Name of organization for application.
- Name, ID, or named URL of organization for application.
type: str
required: True
redirect_uris:
Expand Down
2 changes: 1 addition & 1 deletion awx_collection/plugins/modules/bulk_host_create.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
type: str
inventory:
description:
- Inventory name or ID the hosts should be made a member of.
- Inventory name, ID, or named URL the hosts should be made a member of.
required: True
type: str
extends_documentation_fragment: awx.awx.auth
Expand Down
2 changes: 1 addition & 1 deletion awx_collection/plugins/modules/bulk_job_launch.py
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@
type: str
inventory:
description:
- Inventory name or ID to use for the jobs ran within the bulk job, only used if prompt for inventory is set.
- Inventory name, ID, or named URL to use for the jobs ran within the bulk job, only used if prompt for inventory is set.
type: str
scm_branch:
description:
Expand Down
6 changes: 3 additions & 3 deletions awx_collection/plugins/modules/credential.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
type: str
organization:
description:
- Organization that should own the credential.
- Organization name, ID, or named URL that should own the credential.
type: str
credential_type:
description:
Expand Down Expand Up @@ -92,11 +92,11 @@
default: true
user:
description:
- User that should own this credential.
- User name, ID, or named URL that should own this credential.
type: str
team:
description:
- Team that should own this credential.
- Team name, ID, or named URL that should own this credential.
type: str
state:
description:
Expand Down
4 changes: 2 additions & 2 deletions awx_collection/plugins/modules/credential_input_source.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,12 @@
type: dict
target_credential:
description:
- The credential which will have its input defined by this source
- The credential name, ID, or named URL which will have its input defined by this source
required: true
type: str
source_credential:
description:
- The credential which is the source of the credential lookup
- The credential name, ID, or named URL which is the source of the credential lookup
type: str
state:
description:
Expand Down
4 changes: 2 additions & 2 deletions awx_collection/plugins/modules/execution_environment.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,11 @@
type: str
organization:
description:
- The organization the execution environment belongs to.
- The organization name, ID, or named URL that the execution environment belongs to.
type: str
credential:
description:
- Name of the credential to use for the execution environment.
- Name, ID, or named URL of the credential to use for the execution environment.
type: str
state:
description:
Expand Down
30 changes: 15 additions & 15 deletions awx_collection/plugins/modules/export.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,72 +28,72 @@
default: 'False'
organizations:
description:
- organization names to export
- organization names, IDs, or named URLs to export
type: list
elements: str
users:
description:
- user names to export
- user names, IDs, or named URLs to export
type: list
elements: str
teams:
description:
- team names to export
- team names, IDs, or named URLs to export
type: list
elements: str
credential_types:
description:
- credential type names to export
- credential type names, IDs, or named URLs to export
type: list
elements: str
credentials:
description:
- credential names to export
- credential names, IDs, or named URLs to export
type: list
elements: str
execution_environments:
description:
- execution environment names to export
- execution environment names, IDs, or named URLs to export
type: list
elements: str
notification_templates:
description:
- notification template names to export
- notification template names, IDs, or named URLs to export
type: list
elements: str
inventory_sources:
description:
- inventory soruces to export
- inventory source name, ID, or named URLs to export
type: list
elements: str
inventory:
description:
- inventory names to export
- inventory names, IDs, or named URLs to export
type: list
elements: str
projects:
description:
- project names to export
- project names, IDs, or named URLs to export
type: list
elements: str
job_templates:
description:
- job template names to export
- job template names, IDs, or named URLs to export
type: list
elements: str
workflow_job_templates:
description:
- workflow names to export
- workflow names, IDs, or named URLs to export
type: list
elements: str
applications:
description:
- OAuth2 application names to export
- OAuth2 application names, IDs, or named URLs to export
type: list
elements: str
schedules:
description:
- schedule names to export
- schedule names, IDs, or named URLs to export
type: list
elements: str
requirements:
Expand Down Expand Up @@ -154,7 +154,7 @@ def main():

# The exporter code currently works like the following:
# Empty string == all assets of that type
# Non-Empty string = just a list of assets of that type (by name or ID)
# Non-Empty string = just a list of assets of that type (by name, ID, or named URL)
# Asset type not present or None = skip asset type (unless everything is None, then export all)
# Here we are going to setup a dict of values to export
export_args = {}
Expand Down
6 changes: 3 additions & 3 deletions awx_collection/plugins/modules/group.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
type: str
inventory:
description:
- Inventory the group should be made a member of.
- Inventory name, ID, or named URL that the group should be made a member of.
required: True
type: str
variables:
Expand All @@ -41,12 +41,12 @@
type: dict
hosts:
description:
- List of hosts that should be put in this group.
- List of host names, IDs, or named URLs that should be put in this group.
type: list
elements: str
children:
description:
- List of groups that should be nested inside in this group.
- List of groups names, IDs, or named URLs that should be nested inside in this group.
type: list
elements: str
aliases:
Expand Down
2 changes: 1 addition & 1 deletion awx_collection/plugins/modules/host.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
type: str
inventory:
description:
- Inventory the host should be made a member of.
- Inventory name, ID, or named URL the host should be made a member of.
required: True
type: str
enabled:
Expand Down
4 changes: 2 additions & 2 deletions awx_collection/plugins/modules/instance_group.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
type: str
credential:
description:
- Credential to authenticate with Kubernetes or OpenShift. Must be of type "OpenShift or Kubernetes API Bearer Token".
- Credential name, ID, or named URL to authenticate with Kubernetes or OpenShift. Must be of type "OpenShift or Kubernetes API Bearer Token".
required: False
type: str
is_container_group:
Expand Down Expand Up @@ -74,7 +74,7 @@
type: str
instances:
description:
- The instances associated with this instance_group
- The instance names, IDs, or named URLs associated with this instance_group
required: False
type: list
elements: str
Expand Down
6 changes: 3 additions & 3 deletions awx_collection/plugins/modules/inventory.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
type: str
organization:
description:
- Organization the inventory belongs to.
- Organization name, ID, or named URL the inventory belongs to.
required: True
type: str
variables:
Expand All @@ -62,12 +62,12 @@
type: str
instance_groups:
description:
- list of Instance Groups for this Organization to run on.
- list of Instance Group names, IDs, or named URLs for this Organization to run on.
type: list
elements: str
input_inventories:
description:
- List of Inventories to use as input for Constructed Inventory.
- List of Inventory names, IDs, or named URLs to use as input for Constructed Inventory.
type: list
elements: str
prevent_instance_group_fallback:
Expand Down
8 changes: 4 additions & 4 deletions awx_collection/plugins/modules/inventory_source.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
type: str
inventory:
description:
- Inventory the group should be made a member of.
- Inventory name, ID, or named URL the group should be made a member of.
required: True
type: str
source:
Expand Down Expand Up @@ -70,11 +70,11 @@
type: str
credential:
description:
- Credential to use for the source.
- Credential name, ID, or named URL to use for the source.
type: str
execution_environment:
description:
- Execution Environment to use for the source.
- Execution Environment name, ID, or named URL to use for the source.
type: str
custom_virtualenv:
description:
Expand Down Expand Up @@ -107,7 +107,7 @@
type: int
source_project:
description:
- Project to use as source with scm option
- Project name, ID, or named URL to use as source with scm option
type: str
scm_branch:
description:
Expand Down
2 changes: 1 addition & 1 deletion awx_collection/plugins/modules/inventory_source_update.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
type: str
organization:
description:
- Name of the inventory source's inventory's organization.
- Name, ID, or named URL of the inventory source's inventory's organization.
type: str
wait:
description:
Expand Down
10 changes: 5 additions & 5 deletions awx_collection/plugins/modules/job_launch.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,17 +34,17 @@
type: str
inventory:
description:
- Inventory to use for the job, only used if prompt for inventory is set.
- Inventory name, ID, or named URL to use for the job, only used if prompt for inventory is set.
type: str
organization:
description:
- Organization the job template exists in.
- Organization name, ID, or named URL the job template exists in.
- Used to help lookup the object, cannot be modified using this module.
- If not provided, will lookup by name only, which does not work with duplicates.
type: str
credentials:
description:
- Credential to use for job, only used if prompt for credential is set.
- Credential names, IDs, or named URLs to use for job, only used if prompt for credential is set.
type: list
aliases: ['credential']
elements: str
Expand Down Expand Up @@ -88,15 +88,15 @@
type: dict
execution_environment:
description:
- Execution environment to use for the job, only used if prompt for execution environment is set.
- Execution environment name, ID, or named URL to use for the job, only used if prompt for execution environment is set.
type: str
forks:
description:
- Forks to use for the job, only used if prompt for forks is set.
type: int
instance_groups:
description:
- Instance groups to use for the job, only used if prompt for instance groups is set.
- Instance group names, IDs, or named URLs to use for the job, only used if prompt for instance groups is set.
type: list
elements: str
job_slice_count:
Expand Down
Loading
Loading