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

ansible · Jul 24, 2023 · 63e82aa · 63e82aa
1 parent fc1b74a
commit 63e82aa
Show file tree

Hide file tree

Showing 29 changed files with 107 additions and 107 deletions.
diff --git a/awx_collection/plugins/modules/ad_hoc_command.py b/awx_collection/plugins/modules/ad_hoc_command.py
@@ -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:
@@ -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:

diff --git a/awx_collection/plugins/modules/application.py b/awx_collection/plugins/modules/application.py
@@ -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:

diff --git a/awx_collection/plugins/modules/bulk_host_create.py b/awx_collection/plugins/modules/bulk_host_create.py
@@ -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

diff --git a/awx_collection/plugins/modules/bulk_job_launch.py b/awx_collection/plugins/modules/bulk_job_launch.py
@@ -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:

diff --git a/awx_collection/plugins/modules/credential.py b/awx_collection/plugins/modules/credential.py
@@ -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:
@@ -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:

diff --git a/awx_collection/plugins/modules/credential_input_source.py b/awx_collection/plugins/modules/credential_input_source.py
@@ -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:

diff --git a/awx_collection/plugins/modules/execution_environment.py b/awx_collection/plugins/modules/execution_environment.py
@@ -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:

diff --git a/awx_collection/plugins/modules/export.py b/awx_collection/plugins/modules/export.py
@@ -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:
@@ -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 = {}

diff --git a/awx_collection/plugins/modules/group.py b/awx_collection/plugins/modules/group.py
@@ -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:
@@ -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:

diff --git a/awx_collection/plugins/modules/host.py b/awx_collection/plugins/modules/host.py
@@ -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:

diff --git a/awx_collection/plugins/modules/instance_group.py b/awx_collection/plugins/modules/instance_group.py
@@ -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:
@@ -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

diff --git a/awx_collection/plugins/modules/inventory.py b/awx_collection/plugins/modules/inventory.py
@@ -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:
@@ -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:

diff --git a/awx_collection/plugins/modules/inventory_source.py b/awx_collection/plugins/modules/inventory_source.py
@@ -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:
@@ -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:
@@ -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:

diff --git a/awx_collection/plugins/modules/inventory_source_update.py b/awx_collection/plugins/modules/inventory_source_update.py
@@ -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:

diff --git a/awx_collection/plugins/modules/job_launch.py b/awx_collection/plugins/modules/job_launch.py
@@ -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
@@ -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: