diff options
Diffstat (limited to '')
| -rw-r--r-- | src/mailman/queue/docs/rest.txt | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/src/mailman/queue/docs/rest.txt b/src/mailman/queue/docs/rest.txt new file mode 100644 index 000000000..62e61643f --- /dev/null +++ b/src/mailman/queue/docs/rest.txt @@ -0,0 +1,23 @@ +REST server +=========== + +Mailman is controllable through an administrative RESTful HTTP server. + + >>> from mailman.testing import helpers + >>> master = helpers.TestableMaster(helpers.wait_for_webservice) + >>> master.start('rest') + +The RESTful server can be used to access basic version information. + + >>> dump_json('http://localhost:8001/3.0/system') + http_etag: "..." + mailman_version: GNU Mailman 3.0... (...) + python_version: ... + resource_type_link: https://localhost:8001/3.0/#system + self_link: https://localhost:8001/3.0/system + + +Clean up +-------- + + >>> master.stop() |