From d43ed5b67e17575442fa6db4a7e4de91eda0a3f8 Mon Sep 17 00:00:00 2001 From: James Laska Date: Tue, 14 Oct 2014 08:59:30 -0400 Subject: [PATCH] Correct job_task and job_play help documentation Use the correct query parameter and correct the 'icontains' examples. --- awx/api/templates/api/job_job_plays_list.md | 8 ++++---- awx/api/templates/api/job_job_tasks_list.md | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/awx/api/templates/api/job_job_plays_list.md b/awx/api/templates/api/job_job_plays_list.md index 65982e7bf9..22194615a0 100644 --- a/awx/api/templates/api/job_job_plays_list.md +++ b/awx/api/templates/api/job_job_plays_list.md @@ -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: - ?id__in=1,2,3 + ?event_id__in=1,2,3 Will show only the given ids. - ?id__gt=1 + ?event_id__gt=1 Will show ids greater than the given one. - ?id__lt=3 + ?event_id__lt=3 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. - ?play_icontains=test + ?play__icontains=test Will filter plays matching the substring `test` diff --git a/awx/api/templates/api/job_job_tasks_list.md b/awx/api/templates/api/job_job_tasks_list.md index 48e2fa773a..dca4ed10fe 100644 --- a/awx/api/templates/api/job_job_tasks_list.md +++ b/awx/api/templates/api/job_job_tasks_list.md @@ -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: - ?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`. - ?id__gt=1 + ?event_id__gt=1 Will show ids greater than the given one. - ?id__lt=3 + ?event_id__lt=3 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. - ?task_icontains=test + ?task__icontains=test Will filter tasks matching the substring `test`