External-Mirrors/awx
2
0
Fork 0
mirror of https://github.com/ansible/awx.git synced 2026-02-04 02:58:13 -03:30
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #5124 from AlanCoding/help_text_generalizing

Browse Source 
fix inconsistencies in the workflow API help text pages
This commit is contained in:
Alan Rominger
2017-02-01 17:07:30 -05:00
committed by GitHub
parent 7a9c4c00a2 047880b5db
commit 7021655d7d
2 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
awx/api/templates/api/job_template_survey_spec.md
View File

@@ -1,4 +1,4 @@
POST requests to this resource should include the full specification for a Job Template Survey POST requests to this resource should include the full specification for a {{ model_verbose_name_plural|title }} Survey
Here is an example survey specification: Here is an example survey specification:
@@ -30,7 +30,7 @@ Within each survey item `type` must be one of:
* multiselect: For survey questions where multiple items from a presented list can be selected * multiselect: For survey questions where multiple items from a presented list can be selected
Each item must contain a `question_name` and `question_description` field that describes the survey question itself. Each item must contain a `question_name` and `question_description` field that describes the survey question itself.
The `variable` elements of each survey items represents the key that will be given to the playbook when the job template The `variable` elements of each survey items represents the key that will be given to the playbook when the {{model_verbose_name}}
is launched. It will contain the value as a result of the survey. is launched. It will contain the value as a result of the survey.
Here is a more comprehensive example showing the various question types and their acceptable parameters: Here is a more comprehensive example showing the various question types and their acceptable parameters:

12
awx/api/templates/api/workflow_job_template_copy.md
View File

@@ -1,13 +1,13 @@
Copy a Workflow Job Template: Copy a Workflow Job Template:
Make a GET request to this resource to determine if the current user has 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 permission to copy the {{model_verbose_name}} and whether any linked
templates or prompted fields will be ignored due to permissions problems. templates or prompted fields will be ignored due to permissions problems.
The response will include the following fields: The response will include the following fields:
* `can_copy`: Flag indicating whether the active user has permission to make * `can_copy`: Flag indicating whether the active user has permission to make
a copy of this workflow_job_template, provides same content as the a copy of this {{model_verbose_name}}, provides same content as the
workflow_job_template detail view summary_fields.user_capabilities.copy {{model_verbose_name}} detail view summary_fields.user_capabilities.copy
(boolean, read-only) (boolean, read-only)
* `can_copy_without_user_input`: Flag indicating if the user should be * `can_copy_without_user_input`: Flag indicating if the user should be
prompted for confirmation before the copy is executed (boolean, read-only) prompted for confirmation before the copy is executed (boolean, read-only)
@@ -22,11 +22,11 @@ The response will include the following fields:
to use and will be missing in workflow nodes of the copy (array, read-only) 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 Make a POST request to this endpoint to save a copy of this
workflow_job_template. No POST data is accepted for this action. {{model_verbose_name}}. No POST data is accepted for this action.
If successful, the response status code will be 201. The response body will If successful, the response status code will be 201. The response body will
contain serialized data about the new workflow_job_template, which will be contain serialized data about the new {{model_verbose_name}}, which will be
similar to the original workflow_job_template, but with an additional `@` similar to the original {{model_verbose_name}}, but with an additional `@`
and a timestamp in the name. and a timestamp in the name.
All workflow nodes and connections in the original will also exist in the All workflow nodes and connections in the original will also exist in the