From ca704cdb5cb2e8d88b809be596ba1a532594b6b2 Mon Sep 17 00:00:00 2001 From: AlanCoding Date: Tue, 17 Jan 2017 14:35:30 -0500 Subject: [PATCH] update copy API help text for recent changes --- awx/api/templates/api/workflow_job_cancel.md | 2 +- .../api/workflow_job_template_copy.md | 25 ++++++++++--------- 2 files changed, 14 insertions(+), 13 deletions(-) diff --git a/awx/api/templates/api/workflow_job_cancel.md b/awx/api/templates/api/workflow_job_cancel.md index 01cc11d537..bcdd347d36 100644 --- a/awx/api/templates/api/workflow_job_cancel.md +++ b/awx/api/templates/api/workflow_job_cancel.md @@ -1,7 +1,7 @@ # Cancel Workflow Job Make a GET request to this resource to determine if the workflow job can be -cancelled. The response will include the following field: +canceled. The response will include the following field: * `can_cancel`: Indicates whether this workflow job is in a state that can be canceled (boolean, read-only) diff --git a/awx/api/templates/api/workflow_job_template_copy.md b/awx/api/templates/api/workflow_job_template_copy.md index 238741879d..f28d6466ba 100644 --- a/awx/api/templates/api/workflow_job_template_copy.md +++ b/awx/api/templates/api/workflow_job_template_copy.md @@ -1,8 +1,9 @@ Copy a Workflow Job Template: -Make a GET request to this resource to determine if the workflow_job_template -can be copied and whether any passwords are required to launch the -workflow_job_template. The response will include the following fields: +Make a GET request to this resource to determine if the current user has +permission to copy the workflow_job_template and whether any linked +templates or prompted fields will be ignored due to permissions problems. +The response will include the following fields: * `can_copy`: Flag indicating whether the active user has permission to make a copy of this workflow_job_template, provides same content as the @@ -10,15 +11,15 @@ workflow_job_template. The response will include the following fields: (boolean, read-only) * `can_copy_without_user_input`: Flag indicating if the user should be prompted for confirmation before the copy is executed (boolean, read-only) -* `templates_unable_to_copy`: Names of job templates, projects, and inventory - sources that the active user lacks permission to use and will be missing in - workflow nodes of the copy (array, read-only) -* `inventories_unable_to_copy`: Names of inventories that the active user - lacks permission to use and will be missing in the workflow nodes of the - copy (array, read-only) -* `credentials_unable_to_copy`: Names of credentials that the active user - lacks permission to use and will be missing in the workflow nodes of the - copy (array, read-only) +* `templates_unable_to_copy`: List of node ids of nodes that have a related + job template, project, or inventory that the current user lacks permission + to use and will be missing in workflow nodes of the copy (array, read-only) +* `inventories_unable_to_copy`: List of node ids of nodes that have a related + prompted inventory that the current user lacks permission + to use and will be missing in workflow nodes of the copy (array, read-only) +* `credentials_unable_to_copy`: List of node ids of nodes that have a related + prompted credential that the current user lacks permission + to use and will be missing in workflow nodes of the copy (array, read-only) Make a POST request to this endpoint to save a copy of this workflow_job_template. No POST data is accepted for this action.