From e230b909d444f0fa9ed3d4f847deeb6be0808336 Mon Sep 17 00:00:00 2001
From: Barry Warsaw
Date: Sun, 10 May 2009 16:13:02 -0400
Subject: 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().
---
 src/mailman/queue/docs/rest.txt | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 src/mailman/queue/docs/rest.txt

(limited to 'src/mailman/queue/docs')

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()
-- 
cgit v1.3.1