← Back to branch summary

~barry/mailman/events-and-web

« back to all changes in this revision

Viewing changes to src/mailman/rest/docs/membership.rst

  • Committer: Barry Warsaw
  • Date: 2011-08-18 00:39:11 UTC
  • mfrom: (7036.1.4 bug-827036)
  • Revision ID: barry@list.org-20110818003911-9gef1p84g2pg4p10
 * Four new events are created, and notifications are sent during mailing list
   lifecycle changes:
   - ListCreatingEvent - sent before the mailing list is created
   - ListCreatedEvent  - sent after the mailing list is created
   - ListDeletingEvent - sent before the mailing list is deleted
   - ListDeletedEvent  - sent after the mailing list is deleted
 * Using the above events, when a mailing list is deleted, all its members are
   deleted, as well as all held message requests (but not the held messages
   themselves).  (LP: 827036)

Also: relax the find_member() argument constraints so that even the subscriber
email address is optional.  This is mirrored in the REST API's
.../members/find resource.

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/mailman/rest/docs/membership.rst
308
308
    start: 0
309
309
    total_size: 2
310
310
 
 
311
Or, we can find all the memberships for a particular mailing list.
 
312
 
 
313
    >>> dump_json('http://localhost:9001/3.0/members/find', {
 
314
    ...           'fqdn_listname': 'bee@example.com',
 
315
    ...           })
 
316
    entry 0:
 
317
        address: aperson@example.com
 
318
        fqdn_listname: bee@example.com
 
319
        http_etag: ...
 
320
        role: member
 
321
        self_link: http://localhost:9001/3.0/members/3
 
322
        user: http://localhost:9001/3.0/users/3
 
323
    entry 1:
 
324
        address: bperson@example.com
 
325
        fqdn_listname: bee@example.com
 
326
        http_etag: ...
 
327
        role: member
 
328
        self_link: http://localhost:9001/3.0/members/1
 
329
        user: http://localhost:9001/3.0/users/1
 
330
    entry 2:
 
331
        address: cperson@example.com
 
332
        fqdn_listname: bee@example.com
 
333
        http_etag: ...
 
334
        role: member
 
335
        self_link: http://localhost:9001/3.0/members/2
 
336
        user: http://localhost:9001/3.0/users/2
 
337
    entry 3:
 
338
        address: cperson@example.com
 
339
        fqdn_listname: bee@example.com
 
340
        http_etag: ...
 
341
        role: owner
 
342
        self_link: http://localhost:9001/3.0/members/7
 
343
        user: http://localhost:9001/3.0/users/2
 
344
    http_etag: "66836d0f23bed36fa9e0cda1e5dec7e5b0797743"
 
345
    start: 0
 
346
    total_size: 4
 
347
 
311
348
Or, we can find all the memberships for an address on a particular mailing
312
349
list.
313
350