From 144cbfd6508eb4dceeb13010fb858831bd4d11af Mon Sep 17 00:00:00 2001
From: Joseph Weston <joseph@weston.cloud>
Date: Sat, 2 Mar 2019 03:07:04 +0100
Subject: [PATCH] add API documentation
Signed-off-by: Joseph Weston <joseph@weston.cloud>
---
docs/admin_api/version_api.rst | 22 ++++++++++++++++++++++
1 file changed, 22 insertions(+)
create mode 100644 docs/admin_api/version_api.rst
diff --git a/docs/admin_api/version_api.rst b/docs/admin_api/version_api.rst
new file mode 100644
index 0000000000..30a91b5f43
--- /dev/null
+++ b/docs/admin_api/version_api.rst
@@ -0,0 +1,22 @@
+Version API
+===========
+
+This API returns the running Synapse version and the Python version
+on which Synapse is being run. This is useful when a Synapse instance
+is behind a proxy that does not forward the 'Server' header (which also
+contains Synapse version information).
+
+The api is::
+
+ GET /_matrix/client/r0/admin/server_version
+
+including an ``access_token`` of a server admin.
+
+It returns a JSON body like the following:
+
+.. code:: json
+
+ {
+ "server_version": "0.99.2rc1 (b=develop, abcdef123)",
+ "python_version": "3.6.8"
+ }