diff options
Diffstat (limited to 'src/mailman/rest/docs/lists.rst')
| -rw-r--r-- | src/mailman/rest/docs/lists.rst | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/src/mailman/rest/docs/lists.rst b/src/mailman/rest/docs/lists.rst index 5c65a7951..ce113c9f1 100644 --- a/src/mailman/rest/docs/lists.rst +++ b/src/mailman/rest/docs/lists.rst @@ -50,6 +50,49 @@ You can also query for lists from a particular domain. total_size: 1 +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. + + >>> mlist = create_list('bird@example.com') + >>> transaction.commit() + + >>> dump_json('http://localhost:9001/3.0/domains/example.com/lists' + ... '?count=1&page=1') + entry 0: + display_name: Ant + fqdn_listname: ant@example.com + http_etag: "..." + list_id: ant.example.com + list_name: ant + mail_host: example.com + member_count: 0 + self_link: http://localhost:9001/3.0/lists/ant.example.com + volume: 1 + http_etag: "..." + start: 0 + total_size: 1 + + >>> dump_json('http://localhost:9001/3.0/domains/example.com/lists' + ... '?count=1&page=2') + entry 0: + display_name: Bird + fqdn_listname: bird@example.com + http_etag: "..." + list_id: bird.example.com + list_name: bird + mail_host: example.com + member_count: 0 + self_link: http://localhost:9001/3.0/lists/bird.example.com + volume: 1 + http_etag: "..." + start: 0 + total_size: 1 + + Creating lists via the API ========================== |