summaryrefslogtreecommitdiff
path: root/src/mailman/runners/docs/rest.rst
diff options
context:
space:
mode:
Diffstat (limited to 'src/mailman/runners/docs/rest.rst')
-rw-r--r--src/mailman/runners/docs/rest.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/src/mailman/runners/docs/rest.rst b/src/mailman/runners/docs/rest.rst
index 966c9da80..3b52aa596 100644
--- a/src/mailman/runners/docs/rest.rst
+++ b/src/mailman/runners/docs/rest.rst
@@ -10,7 +10,17 @@ Mailman is controllable through an administrative `REST`_ HTTP server.
The RESTful server can be used to access basic version information.
+ >>> dump_json('http://localhost:9001/3.1/system')
+ api_version: 3.1
+ http_etag: "..."
+ mailman_version: GNU Mailman 3...
+ python_version: ...
+ self_link: http://localhost:9001/3.1/system/versions
+
+Previous versions of the REST API can also be accessed.
+
>>> dump_json('http://localhost:9001/3.0/system')
+ api_version: 3.0
http_etag: "..."
mailman_version: GNU Mailman 3...
python_version: ...