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

Correct job_task and job_play help documentation

Browse Source 
Use the correct query parameter and correct the 'icontains' examples.
This commit is contained in:
James Laska
2014-10-14 08:59:30 -04:00
parent 995bf8c58f
commit d43ed5b67e
2 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
awx/api/templates/api/job_job_plays_list.md
View File

@@ -4,15 +4,15 @@ Make a GET request to retrieve the list of aggregated play data associated with
This endpoints supports a limited filtering subset: This endpoints supports a limited filtering subset:
?id__in=1,2,3 ?event_id__in=1,2,3
Will show only the given ids. Will show only the given ids.
?id__gt=1 ?event_id__gt=1
Will show ids greater than the given one. Will show ids greater than the given one.
?id__lt=3 ?event_id__lt=3
Will show ids less than the given one. Will show ids less than the given one.
@@ -20,7 +20,7 @@ Will show ids less than the given one.
Will show only failed plays. Alternatively `false` may be used. Will show only failed plays. Alternatively `false` may be used.
?play_icontains=test ?play__icontains=test
Will filter plays matching the substring `test` Will filter plays matching the substring `test`

8
awx/api/templates/api/job_job_tasks_list.md
View File

@@ -6,15 +6,15 @@ Make a GET request to retrieve the list of aggregated task data associated with
This endpoints supports a limited filtering subset: This endpoints supports a limited filtering subset:
?id__in=1,2,3 ?event_id__in=1,2,3
Will show only the given task ids under the play given by `event_id`. Will show only the given task ids under the play given by `event_id`.
?id__gt=1 ?event_id__gt=1
Will show ids greater than the given one. Will show ids greater than the given one.
?id__lt=3 ?event_id__lt=3
Will show ids less than the given one. Will show ids less than the given one.
@@ -22,7 +22,7 @@ Will show ids less than the given one.
Will show only failed plays. Alternatively `false` may be used. Will show only failed plays. Alternatively `false` may be used.
?task_icontains=test ?task__icontains=test
Will filter tasks matching the substring `test` Will filter tasks matching the substring `test`