summaryrefslogtreecommitdiff
path: root/src/mailman/queue/docs/rest.txt
diff options
context:
space:
mode:
authorBarry Warsaw2009-05-10 16:13:02 -0400
committerBarry Warsaw2009-05-10 16:13:02 -0400
commite230b909d444f0fa9ed3d4f847deeb6be0808336 (patch)
treefa51063da700d3ed63c8a4cd39b9b5ec6a3d5154 /src/mailman/queue/docs/rest.txt
parent374fbfef115c54f354b1fa823f0feef5c22c9d38 (diff)
downloadmailman-e230b909d444f0fa9ed3d4f847deeb6be0808336.tar.gz
mailman-e230b909d444f0fa9ed3d4f847deeb6be0808336.tar.zst
mailman-e230b909d444f0fa9ed3d4f847deeb6be0808336.zip
More tests for the REST server, this time, for the queue runner.
Add logging to the RESTRunner. Also, use pkg_resources.resource_stream() instead of .resource_string() where appropriate. Add a bunch of XXX comments for things I need to figure out about the Zope-ish parts of the lazr.restful implementation. Change __getitem__() api to _lookup().
Diffstat (limited to 'src/mailman/queue/docs/rest.txt')
-rw-r--r--src/mailman/queue/docs/rest.txt23
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()