summaryrefslogtreecommitdiff
path: root/src/mailman/rest/docs
diff options
context:
space:
mode:
authorBarry Warsaw2011-08-14 18:50:19 -0400
committerBarry Warsaw2011-08-14 18:50:19 -0400
commit061643ac76b4fba0b95b9e6260df44c69412ec07 (patch)
treefbe9946566879c6ea8b02355443346d37720c83e /src/mailman/rest/docs
parentc93ef05f6f4bda7826f51ea2f2a820581683b476 (diff)
downloadmailman-061643ac76b4fba0b95b9e6260df44c69412ec07.tar.gz
mailman-061643ac76b4fba0b95b9e6260df44c69412ec07.tar.zst
mailman-061643ac76b4fba0b95b9e6260df44c69412ec07.zip
Remove role plurals from /lists/<fqdn_listname/rosters/<role>
Diffstat (limited to 'src/mailman/rest/docs')
-rw-r--r--src/mailman/rest/docs/membership.rst19
1 files changed, 17 insertions, 2 deletions
diff --git a/src/mailman/rest/docs/membership.rst b/src/mailman/rest/docs/membership.rst
index 6932459dc..426b80acf 100644
--- a/src/mailman/rest/docs/membership.rst
+++ b/src/mailman/rest/docs/membership.rst
@@ -169,7 +169,7 @@ User ids are different than member ids.
We can also get just the members of a single mailing list.
>>> dump_json(
- ... 'http://localhost:9001/3.0/lists/ant@example.com/roster/members')
+ ... 'http://localhost:9001/3.0/lists/ant@example.com/roster/member')
entry 0:
address: aperson@example.com
fqdn_listname: ant@example.com
@@ -254,6 +254,21 @@ mailing list.
start: 0
total_size: 7
+We can access all the owners of a list.
+
+ >>> dump_json(
+ ... 'http://localhost:9001/3.0/lists/bee@example.com/roster/owner')
+ entry 0:
+ address: cperson@example.com
+ fqdn_listname: bee@example.com
+ http_etag: ...
+ role: owner
+ self_link: http://localhost:9001/3.0/members/7
+ user: http://localhost:9001/3.0/users/2
+ http_etag: ...
+ start: 0
+ total_size: 1
+
Finding members
===============
@@ -298,7 +313,7 @@ list.
>>> dump_json('http://localhost:9001/3.0/members/find', {
... 'subscriber': 'cperson@example.com',
- ... 'fqdn_listname': 'bee@example.com',
+ ... 'fqdn_listname': 'bee@example.com',
... })
entry 0:
address: cperson@example.com