summaryrefslogtreecommitdiff
path: root/src/mailman/rest/docs/addresses.rst
diff options
context:
space:
mode:
authorBarry Warsaw2014-04-15 17:54:35 -0400
committerBarry Warsaw2014-04-15 17:54:35 -0400
commit13823e4d2b9bea190dd207a02a8107bc43ee49fe (patch)
tree0917bab22a2d9d422567c80d2c27a4e601103ea2 /src/mailman/rest/docs/addresses.rst
parent29d6d587389c32eb84d7faa51e3072e02e385c2d (diff)
downloadmailman-13823e4d2b9bea190dd207a02a8107bc43ee49fe.tar.gz
mailman-13823e4d2b9bea190dd207a02a8107bc43ee49fe.tar.zst
mailman-13823e4d2b9bea190dd207a02a8107bc43ee49fe.zip
* Fixed a crash in the REST server when searching for nonmembers via
``/find`` which we've never seen before, because those members only have an address record, not a user record. This requires a small change in the API where the JSON response's ``address`` key now contains the URL to the address resource, the new ``email`` key contains the email address as a string, and the ``user`` key is optional.
Diffstat (limited to 'src/mailman/rest/docs/addresses.rst')
-rw-r--r--src/mailman/rest/docs/addresses.rst15
1 files changed, 10 insertions, 5 deletions
diff --git a/src/mailman/rest/docs/addresses.rst b/src/mailman/rest/docs/addresses.rst
index be01dd623..fec0c194b 100644
--- a/src/mailman/rest/docs/addresses.rst
+++ b/src/mailman/rest/docs/addresses.rst
@@ -261,16 +261,18 @@ Elle can get her memberships for each of her email addresses.
>>> dump_json('http://localhost:9001/3.0/addresses/'
... 'elle@example.com/memberships')
entry 0:
- address: elle@example.com
+ address: http://localhost:9001/3.0/addresses/elle@example.com
delivery_mode: regular
+ email: elle@example.com
http_etag: "..."
list_id: ant.example.com
role: member
self_link: http://localhost:9001/3.0/members/1
user: http://localhost:9001/3.0/users/2
entry 1:
- address: elle@example.com
+ address: http://localhost:9001/3.0/addresses/elle@example.com
delivery_mode: regular
+ email: elle@example.com
http_etag: "..."
list_id: bee.example.com
role: member
@@ -298,16 +300,18 @@ does not show up in the list of memberships for his other address.
>>> dump_json('http://localhost:9001/3.0/addresses/'
... 'elle@example.com/memberships')
entry 0:
- address: elle@example.com
+ address: http://localhost:9001/3.0/addresses/elle@example.com
delivery_mode: regular
+ email: elle@example.com
http_etag: "..."
list_id: ant.example.com
role: member
self_link: http://localhost:9001/3.0/members/1
user: http://localhost:9001/3.0/users/2
entry 1:
- address: elle@example.com
+ address: http://localhost:9001/3.0/addresses/elle@example.com
delivery_mode: regular
+ email: elle@example.com
http_etag: "..."
list_id: bee.example.com
role: member
@@ -320,8 +324,9 @@ does not show up in the list of memberships for his other address.
>>> dump_json('http://localhost:9001/3.0/addresses/'
... 'eperson@example.com/memberships')
entry 0:
- address: eperson@example.com
+ address: http://localhost:9001/3.0/addresses/eperson@example.com
delivery_mode: regular
+ email: eperson@example.com
http_etag: "..."
list_id: bee.example.com
role: member