diff --git a/awx/api/templates/api/ad_hoc_command_ad_hoc_command_events_list.md b/awx/api/templates/api/ad_hoc_command_ad_hoc_command_events_list.md new file mode 100644 index 0000000000..056ef2b685 --- /dev/null +++ b/awx/api/templates/api/ad_hoc_command_ad_hoc_command_events_list.md @@ -0,0 +1 @@ +{% include "api/job_job_events_list.md" %} diff --git a/awx/api/templates/api/inventory_update_events_list.md b/awx/api/templates/api/inventory_update_events_list.md new file mode 100644 index 0000000000..056ef2b685 --- /dev/null +++ b/awx/api/templates/api/inventory_update_events_list.md @@ -0,0 +1 @@ +{% include "api/job_job_events_list.md" %} diff --git a/awx/api/templates/api/job_job_events_list.md b/awx/api/templates/api/job_job_events_list.md new file mode 100644 index 0000000000..2d0f69893e --- /dev/null +++ b/awx/api/templates/api/job_job_events_list.md @@ -0,0 +1,21 @@ +{% include "api/sub_list_api_view.md" %} +{% ifmeth GET %} +## Special limit feature for event list views + +Use the `limit` query string parameter to opt out of the pagination keys. +Doing this can improve response times for jobs that produce a large volume +of outputs. + + ?limit=25 + +This will set the page size to 25 and the `previous` and `next` keys will be +omitted from the response data. The data structure will look like this. + + { + "results": [ + ... + ] + } + + +{% endifmeth %} diff --git a/awx/api/templates/api/job_job_plays_list.md b/awx/api/templates/api/job_job_plays_list.md deleted file mode 100644 index e546f8d35c..0000000000 --- a/awx/api/templates/api/job_job_plays_list.md +++ /dev/null @@ -1,25 +0,0 @@ -Make a GET request to retrieve the list of aggregated play data associated with a job - -## Filtering - -This endpoints supports a limited filtering subset: - - ?event_id__in=1,2,3 - -Will show only the given ids. - - ?event_id__gt=1 - -Will show ids greater than the given one. - - ?event_id__lt=3 - -Will show ids less than the given one. - - ?failed=true - -Will show only failed plays. Alternatively `false` may be used. - - ?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 deleted file mode 100644 index 892e8bb99e..0000000000 --- a/awx/api/templates/api/job_job_tasks_list.md +++ /dev/null @@ -1,27 +0,0 @@ -Make a GET request to retrieve the list of aggregated task data associated with the play given by event_id. - -`event_id` is a required query parameter and must match the job event id of the parent play in order to receive the list of tasks associated with the play - -## Filtering - -This endpoints supports a limited filtering subset: - - ?event_id__in=1,2,3 - -Will show only the given task ids under the play given by `event_id`. - - ?event_id__gt=1 - -Will show ids greater than the given one. - - ?event_id__lt=3 - -Will show ids less than the given one. - - ?failed=true - -Will show only failed plays. Alternatively `false` may be used. - - ?task__icontains=test - -Will filter tasks matching the substring `test` diff --git a/awx/api/templates/api/project_update_events_list.md b/awx/api/templates/api/project_update_events_list.md new file mode 100644 index 0000000000..056ef2b685 --- /dev/null +++ b/awx/api/templates/api/project_update_events_list.md @@ -0,0 +1 @@ +{% include "api/job_job_events_list.md" %} diff --git a/awx/api/templates/api/system_job_events_list.md b/awx/api/templates/api/system_job_events_list.md new file mode 100644 index 0000000000..056ef2b685 --- /dev/null +++ b/awx/api/templates/api/system_job_events_list.md @@ -0,0 +1 @@ +{% include "api/job_job_events_list.md" %}