|
Size: 4942
Comment:
|
Size: 6707
Comment: added comment re: URL path question at the end.
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| #pragma page-filename DEV/versions/7962741 | #pragma page-filename DEV/versions/14352448 |
| Line 17: | Line 17: |
| * '''identity''' (create, modify) | * '''identity''' (create, modify, delete) |
| Line 47: | Line 47: |
| <<BR>> | |
| Line 52: | Line 52: |
| Initial Considerations |
[[DEV/Initial Considerations]]<<BR>><<BR>><<BR>><<BR>><<BR>><<BR>><<BR>><<BR>> |
| Line 62: | Line 61: |
| || TODO: What does it list? | || List all top-level URLS <<BR>> |
| Line 65: | Line 64: |
| || TODO: What does it list? | || List all children URLS <<BR>> |
| Line 68: | Line 67: |
| || Return Mailman and Python version, read-only | || Return Mailman and Python version (read-only) |
| Line 77: | Line 76: |
| || List of statistics available | || List of statistics available below |
| Line 80: | Line 79: |
| || TODO: What does it list? <<BR>>Show lists by activity <<BR>> | || Show lists by activity (performance, tuning aspects) <<BR>> |
| Line 83: | Line 82: |
| || TODO: What does it list? <<BR>>Show comparison of lists activity within the same domain <<BR>> | || Show comparison of lists activity within the same domain <<BR>> |
| Line 85: | Line 84: |
| /stats/list || TODO: What does it list? <<BR>>Show list activity (new messages per day, replies to new messages same day) <<BR>> |
/stats/lists || list all lists within the domain <<BR>> |
| Line 88: | Line 87: |
| /stats/users || TODO: What does it list? * Top Ten Senders * Top Ten Contributers |
/stats/lists/<list-id> || Show list activity (new messages per day, replies to new messages same day) == /stats/users/ || * Top Ten Senders * Top Ten Contributers * Show a list of all users |
| Line 95: | Line 96: |
| || TODO: What does it list? | || * Number of posts per site * Number of posts per domain * Number of posts per list * Bounces per mail-address |
| Line 98: | Line 102: |
| || TODO: What does it list? <<BR>>List of all users <<BR>> | || List of preferred email-addresses (e-Mail, Full name) <<BR>> |
| Line 100: | Line 104: |
| /users/<username> || TODO: What does it list? <<BR>> |
/users/<user-id> || All information related to that person <<BR>> |
| Line 103: | Line 107: |
| /subscriptions/ || TODO: What does it list? <<BR>> |
/users/<user-id/<setting> || Specific settings related with a person (identity, MIME-settings, Vacation, etc.) <<BR>> |
| Line 106: | Line 110: |
| /subscriptions/... || TODO: What's beneath? |
/members/ || A list of all members (address, mailinglist, role) <<BR>> == /members/... || membership management (moderated, unsubscribe, etc.) <<BR>> |
| Line 110: | Line 117: |
| || TODO: What's beneath? | || A list of all email-addresses the system knows about <<BR>> == /addresses/<address> <<BR>> || information on an address (when was it validated, link to the user associated with it, etc.) <<BR>> |
| Line 113: | Line 123: |
| || returns list of (mailing list name, URL, public/private flag) tuples. POST is used to create a new list and redirect | || returns list of list-ids (mailing list name, URL, public/private flag) tuples. |
| Line 122: | Line 132: |
| || TODO: What does it list? <<BR>>List all lists within a domain? <<BR>>Configure global/default settings of all lists within the domain? <<BR>> | || List all domains within the site (hostname, web hostname, description, contact address) <<BR>> == /domains/<domain-id> <<BR>> || Manage that domain <<BR>> |
| Line 125: | Line 138: |
| || A list of all messages? No... | || List of all URLs below <<BR>> |
| Line 127: | Line 140: |
| /messages/<message-id> || TODO: What does it list? <<BR>>Header-Info: Sender, Recipient, Date, Subject, Size <<BR>> |
/messages/ids/ <<BR>> || A list of all message-ids == /messages/ids/<message-id> || Message specific info: Sender, Recipient, Date, Subject, Size <<BR>> == /messages/hashes/ <<BR>> || A list of all message-hashes <<BR>> == /messages/hashes/<message-hashes> <<BR>> || List of all message-hashes (see: [[DEV/Stable URLs]]) == /policies/ <<BR>> || General policy for all lists on the site <<BR>> == /policies/domains/ || List of domains whose policy differs from the general site policy <<BR>> == /policies/domains/<domain> <<BR>> || A domain specific policy <<BR>> == /policies/lists/ <<BR>> || List of lists whose policy differs from the general site policy == /policies/lists/<list> || A list specific policy <<BR>> |
| Line 142: | Line 179: |
{{{ Unless the REST interface is designed to replace the Browser interface, it shouldn't expected a user can navigate without error by manufacturing urls, no? In either case /list/mailman-developers/ is preferable for seeing where your current location via the url. 123456 is uninformative. Unless there is some unfailing reason to disallow it there is no reason to disallow names like foo/bar would just be escaped to foo%2Fbar. Another option is to have a urlsafe name generator that replaced unsafe characters with a '-'. then the name 'foo-bar' could be used while preserving readability in the url }}} |
Sketch of a REST interface to Mailman
This interface isn't intended to be exposed to the Internet at large, so there's no mention of access control. It would be used as a back-end, on top of which the existing Mailman interface, or a fancy GUI application, or administrative scripts, could be built.
Resource Types
- Lists
- Users
- Subscriptions (which tie together a single user and a single list).
- Messages
Use Cases
h3. user
preferences (create, modify)
Changes a user can make to his list-specific settings, but also to all of his subscriptions on the server.
identity (create, modify, delete)
Changes a user can make to his list-specific identity, but also to all of his identities on all subscriptions on the server.
subscription (create, modify, delete)
Changes a user can make to his list-specific subscription settings e.g. preferred mail-address, but also to all of his subscriptions on the server.
h3. moderator
messages (approve, reject, discard, defer)
Handle pending requests.
subscriptions (approve, reject, defer)
Handle subscription tasks.
h3. owner
lists (create, modify, delete)
Manage list related tasks.
subscriptions (create, modify, delete)
Handle subscription tasks.
users (create, modify, delete)
Handle user management tasks.
statistics (read)
Read server, domain, list, user-related statistics e.g. Top Ten Posters, List Activity Meter
Principles
We use JSON. Libraries are available for most relevant programming languages and it's reasonably human-readable.
Also taking the recommendation of Leonard Richardson we will also honor the representation request in the Accept and Accept-Language headers.
URL Space
Unless otherwise specified, all these URLs return a data structure encoded as JSON.
| URL |
Action |
| / | List all top-level URLS |
| /sys | List all children URLS |
| /sys/version | Return Mailman and Python version (read-only) |
| /sys/plugins | List all plugins (name, description, author, version) |
| /sys/plugins/<plugin> |
Detailed info on a plugin |
| /stats/ | List of statistics available below |
| /stats/site | Show lists by activity (performance, tuning aspects) |
| /stats/domain | Show comparison of lists activity within the same domain |
| /stats/lists | list all lists within the domain |
| /stats/lists/<list-id> | Show list activity (new messages per day, replies to new messages same day) |
| /stats/users/ | * Top Ten Senders * Top Ten Contributers * Show a list of all users |
| /stats/users/<username> | * Number of posts per site * Number of posts per domain * Number of posts per list * Bounces per mail-address |
| /users/ | List of preferred email-addresses (e-Mail, Full name) |
| /users/<user-id> | All information related to that person |
| /users/<user-id/<setting> | Specific settings related with a person (identity, MIME-settings, Vacation, etc.) |
| /members/ | A list of all members (address, mailinglist, role) |
| /members/... | membership management (moderated, unsubscribe, etc.) |
| /addresses/ | A list of all email-addresses the system knows about |
| /addresses/<address> |
information on an address (when was it validated, link to the user associated with it, etc.) |
| /lists/ | returns list of list-ids (mailing list name, URL, public/private flag) tuples. |
| /lists/<list-id> | lists list homepage info |
| /list/<list-id>/<setting> | Arbitrary <settings> that configure a list |
| /domains/ | List all domains within the site (hostname, web hostname, description, contact address) |
| /domains/<domain-id> |
Manage that domain |
| /messages/ | List of all URLs below |
| /messages/ids/ |
A list of all message-ids |
| /messages/ids/<message-id> | Message specific info: Sender, Recipient, Date, Subject, Size |
| /messages/hashes/ |
A list of all message-hashes |
| /messages/hashes/<message-hashes> |
List of all message-hashes (see: DEV/Stable URLs) |
| /policies/ |
General policy for all lists on the site |
| /policies/domains/ | List of domains whose policy differs from the general site policy |
| /policies/domains/<domain> |
A domain specific policy |
| /policies/lists/ |
List of lists whose policy differs from the general site policy |
| /policies/lists/<list> | A list specific policy |
Unresolved Questions
What to do with bounce status/other logging information?
By this I mean the info that the Mailman core will generate that the other side may need to know.
How should passwords be dealt with?
Should there just be a password='abcdef' setting among all the others, or should the client be expected to SHA1-encode the password or do other stuff with it?
In the URL paths, do we want to use human-readable list names and e-mail addresses, or identifiers?
For example, do we want /list/mailman-developers/, or /list/123456/? The human-readable names make it convenient to poke around on the REST interface, but also require us to worry about quoting can you have a list named 'foo/bar'? and people may assemble URLs instead of looking up the correct one.
Unless the REST interface is designed to replace the Browser interface, it shouldn't expected a user can navigate without error by manufacturing urls, no? In either case /list/mailman-developers/ is preferable for seeing where your current location via the url. 123456 is uninformative. Unless there is some unfailing reason to disallow it there is no reason to disallow names like foo/bar would just be escaped to foo%2Fbar. Another option is to have a urlsafe name generator that replaced unsafe characters with a '-'. then the name 'foo-bar' could be used while preserving readability in the url
Comments
I'm needing to build a standalone webservice for Mailman that our content manager can access. I'm most comfortable in PHP, so it's probably going to be PHP instead of Python.
But it will be needing to support authentication for usage. I'm planning on it just being a wrapper for the command line tools. If folks are interested, I could contribute our code as it goes. All our work here at the City of Bloomington is GPL. Either way, I'd be very interested in seeing a native RESTful interface come with Mailman