diff options
| author | Florian Fuchs | 2014-04-13 14:48:20 -0400 |
|---|---|---|
| committer | Florian Fuchs | 2014-04-13 14:48:20 -0400 |
| commit | 3a306dec00019225cb6ebb8415077657bb2022b1 (patch) | |
| tree | 0f6090af19d12cd3d15970116ff6ded45f23449d /src/mailman/rest/docs | |
| parent | 3a9725b91ef822122a70170333d71b58e1788a78 (diff) | |
| download | mailman-3a306dec00019225cb6ebb8415077657bb2022b1.tar.gz mailman-3a306dec00019225cb6ebb8415077657bb2022b1.tar.zst mailman-3a306dec00019225cb6ebb8415077657bb2022b1.zip | |
* Added an API endpoint to POST new email addresses to a user resource.
* Updated docs.
Diffstat (limited to 'src/mailman/rest/docs')
| -rw-r--r-- | src/mailman/rest/docs/addresses.rst | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/src/mailman/rest/docs/addresses.rst b/src/mailman/rest/docs/addresses.rst index f05b6b9b2..a12d2cbbc 100644 --- a/src/mailman/rest/docs/addresses.rst +++ b/src/mailman/rest/docs/addresses.rst @@ -174,6 +174,40 @@ addresses live in the /addresses namespace. self_link: http://localhost:9001/3.0/addresses/dave@example.com +A user record can have multiple email addresses associated with it. +Adding a new address can be done by posting to the /addresses namespace. + + >>> dump_json('http://localhost:9001/3.0/users/dave@example.com/' + ... 'addresses', { + ... 'email': 'dave.person@example.org' + ... }) + content-length: 0 + date: ... + location: http://localhost:9001/3.0/addresses/dave.person@example.org + server: ... + status: 201 + +The new address now shows up in the result of the user's /addresses endpoint. + + >>> dump_json('http://localhost:9001/3.0/users/dave@example.com/addresses') + entry 0: + email: dave.person@example.org + http_etag: "..." + original_email: dave.person@example.org + registered_on: 2005-08-01T07:49:23 + self_link: http://localhost:9001/3.0/addresses/dave.person@example.org + entry 1: + display_name: Dave Person + email: dave@example.com + http_etag: "..." + original_email: dave@example.com + registered_on: 2005-08-01T07:49:23 + self_link: http://localhost:9001/3.0/addresses/dave@example.com + http_etag: "..." + start: 0 + total_size: 2 + + Memberships =========== |