diff options
| author | Barry Warsaw | 2013-03-21 11:35:58 -0700 |
|---|---|---|
| committer | Barry Warsaw | 2013-03-21 11:35:58 -0700 |
| commit | 4dfa297d7aa68039782ad56262c3465d0a4dc31e (patch) | |
| tree | 722415e6cd3a9e9528fa2839d5ce4747f12a2a3b /src/mailman/rest/docs/lists.rst | |
| parent | 2b9b4feff3845cd1eb6799037d8516510608e1a0 (diff) | |
| download | mailman-4dfa297d7aa68039782ad56262c3465d0a4dc31e.tar.gz mailman-4dfa297d7aa68039782ad56262c3465d0a4dc31e.tar.zst mailman-4dfa297d7aa68039782ad56262c3465d0a4dc31e.zip | |
Diffstat (limited to 'src/mailman/rest/docs/lists.rst')
| -rw-r--r-- | src/mailman/rest/docs/lists.rst | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/src/mailman/rest/docs/lists.rst b/src/mailman/rest/docs/lists.rst index ce113c9f1..295e8c0b7 100644 --- a/src/mailman/rest/docs/lists.rst +++ b/src/mailman/rest/docs/lists.rst @@ -53,9 +53,11 @@ You can also query for lists from a particular domain. Paginating over list records ---------------------------- -List records, as well as user and member records can be requested in page -chunks that are defined with the GET params ``count`` and ``page``, with -``count`` defining the length of the collection to be returned. +Instead of returning all the list records at once, it's possible to return +them in pages by adding the GET parameters ``count`` and ``page`` to the +request URI. Page 1 is the first page and ``count`` defines the size of the +page. +:: >>> mlist = create_list('bird@example.com') >>> transaction.commit() |