Add OPTIONS documentation for new job limit feature

This commit is contained in:
Alan Rominger 2021-06-07 11:11:22 -04:00
parent d3b20e6585
commit 2eb1e4bbe3
No known key found for this signature in database
GPG Key ID: C2D7EAAA12B63559

View 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 %}