summaryrefslogtreecommitdiff
path: root/src/mailman/rest/docs
diff options
context:
space:
mode:
authorBarry Warsaw2011-03-18 14:18:30 -0400
committerBarry Warsaw2011-03-18 14:18:30 -0400
commitb81ebbf535e8a53b10d4b0f82ecedd8971314610 (patch)
tree34e316aca6c61db56e31355fcee0ae10352d879c /src/mailman/rest/docs
parentef3a4a87e2c0f4b640e31afc4828d2edbd005846 (diff)
downloadmailman-b81ebbf535e8a53b10d4b0f82ecedd8971314610.tar.gz
mailman-b81ebbf535e8a53b10d4b0f82ecedd8971314610.tar.zst
mailman-b81ebbf535e8a53b10d4b0f82ecedd8971314610.zip
* Start fleshing out the REST API for users.
* Remove mmsitepass.py - there is no more site password.
Diffstat (limited to 'src/mailman/rest/docs')
-rw-r--r--src/mailman/rest/docs/users.txt16
1 files changed, 16 insertions, 0 deletions
diff --git a/src/mailman/rest/docs/users.txt b/src/mailman/rest/docs/users.txt
new file mode 100644
index 000000000..418b07f4c
--- /dev/null
+++ b/src/mailman/rest/docs/users.txt
@@ -0,0 +1,16 @@
+=====
+Users
+=====
+
+The REST API can be used to add and remove users, add and remove user
+addresses, and change their preferred address, passord, or name. Users are
+different than members; the latter represents an email address subscribed to a
+specific mailing list. Users are just people that Mailman knows about.
+
+There are no users yet.
+
+ >>> dump_json('http://localhost:9001/3.0/users')
+ http_etag: "..."
+ start: 0
+ total_size: 0
+