summaryrefslogtreecommitdiff
path: root/src/mailman/rest/docs
diff options
context:
space:
mode:
authorAurélien Bompard2015-12-15 19:40:15 +0100
committerBarry Warsaw2016-01-13 19:36:29 -0500
commitbbe2a437d2c1b369cc05abd0dae9305c36561202 (patch)
treee2091f732751fe3a64b9bea3da38b255a8e91fd2 /src/mailman/rest/docs
parent5a6344a8506ef6d2032b9c76e54b0a5c5b887e9a (diff)
downloadmailman-bbe2a437d2c1b369cc05abd0dae9305c36561202.tar.gz
mailman-bbe2a437d2c1b369cc05abd0dae9305c36561202.tar.zst
mailman-bbe2a437d2c1b369cc05abd0dae9305c36561202.zip
Member search can be done using GET requests
Diffstat (limited to 'src/mailman/rest/docs')
-rw-r--r--src/mailman/rest/docs/membership.rst22
1 files changed, 22 insertions, 0 deletions
diff --git a/src/mailman/rest/docs/membership.rst b/src/mailman/rest/docs/membership.rst
index 61ac2c33e..bd4a85eeb 100644
--- a/src/mailman/rest/docs/membership.rst
+++ b/src/mailman/rest/docs/membership.rst
@@ -626,6 +626,28 @@ Finally, we can search for a specific member given all three criteria.
start: 0
total_size: 1
+Search can also be performed using HTTP GET requests.
+
+ >>> dump_json('http://localhost:9001/3.0/members/find'
+ ... '?subscriber=cperson@example.com'
+ ... '&list_id=bee.example.com'
+ ... '&role=member'
+ ... )
+ entry 0:
+ address: http://localhost:9001/3.0/addresses/cperson@example.com
+ delivery_mode: regular
+ email: cperson@example.com
+ http_etag: ...
+ list_id: bee.example.com
+ member_id: 2
+ moderation_action: defer
+ role: member
+ self_link: http://localhost:9001/3.0/members/2
+ user: http://localhost:9001/3.0/users/2
+ http_etag: ...
+ start: 0
+ total_size: 1
+
Joining a mailing list
======================