mirror of
https://github.com/ansible/awx.git
synced 2026-01-13 02:50:02 -03:30
Add OPTIONS documentation for new job limit feature
This commit is contained in:
parent
d3b20e6585
commit
2eb1e4bbe3
21
awx/api/templates/api/job_job_events_list.md
Normal file
21
awx/api/templates/api/job_job_events_list.md
Normal file
@ -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 %}
|
||||
Loading…
x
Reference in New Issue
Block a user