From 2eb1e4bbe318dd342d4b24fb60d5d2b07fa05171 Mon Sep 17 00:00:00 2001 From: Alan Rominger Date: Mon, 7 Jun 2021 11:11:22 -0400 Subject: [PATCH] Add OPTIONS documentation for new job limit feature --- awx/api/templates/api/job_job_events_list.md | 21 ++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 awx/api/templates/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..678c19b829 --- /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 job events + +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 %}