diff options
Diffstat (limited to 'docs/api-usage.rst')
| -rw-r--r-- | docs/api-usage.rst | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/api-usage.rst b/docs/api-usage.rst index c27ba25..ad188ce 100644 --- a/docs/api-usage.rst +++ b/docs/api-usage.rst @@ -225,6 +225,15 @@ handle the next calls to the API when required: for item in items: print(item.attributes) +The generator exposes extra listing information as received by the server: + +* ``current_page``: current page number (first page is 1) +* ``prev_page``: if ``None`` the current page is the first one +* ``next_page``: if ``None`` the current page is the last one +* ``per_page``: number of items per page +* ``total_pages``: total number of pages available +* ``total``: total number of items in the list + Sudo ==== |