From 73636cab69c32746ef6b7708deeeb0c718b7b3b9 Mon Sep 17 00:00:00 2001
From: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
Date: Thu, 3 Jun 2021 14:06:03 +0100
Subject: Convert admin api docs to markdown (#10089)

So that they render nicely in mdbook (see #10086), and so that we no longer have a mix of structured text languages in our documentation (excluding files outside of `docs/`).
---
 docs/admin_api/version_api.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 docs/admin_api/version_api.md

(limited to 'docs/admin_api/version_api.md')

diff --git a/docs/admin_api/version_api.md b/docs/admin_api/version_api.md
new file mode 100644
index 0000000000..efb4a0c0f7
--- /dev/null
+++ b/docs/admin_api/version_api.md
@@ -0,0 +1,21 @@
+# 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 /_synapse/admin/v1/server_version
+```
+
+It returns a JSON body like the following:
+
+```json
+{
+    "server_version": "0.99.2rc1 (b=develop, abcdef123)",
+    "python_version": "3.6.8"
+}
+```
-- 
cgit 1.5.1