summary refs log tree commit diff
path: root/docs/client-server/swagger_matrix/api-docs
diff options
context:
space:
mode:
authorKegan Dougal <kegan@matrix.org>2014-08-22 13:40:37 +0100
committerKegan Dougal <kegan@matrix.org>2014-08-22 13:40:37 +0100
commite3c6c9057bd62b2a3c4ef2fd894b9c68c8e06bba (patch)
tree809b9b9dee356185b28b77320a6567511c26bd52 /docs/client-server/swagger_matrix/api-docs
parentAdded final jsfiddle: an example app demonstrating most of the c2s api. (diff)
downloadsynapse-e3c6c9057bd62b2a3c4ef2fd894b9c68c8e06bba.tar.xz
Added initial swagger REST API spec.
Diffstat (limited to 'docs/client-server/swagger_matrix/api-docs')
-rw-r--r--docs/client-server/swagger_matrix/api-docs38
1 files changed, 38 insertions, 0 deletions
diff --git a/docs/client-server/swagger_matrix/api-docs b/docs/client-server/swagger_matrix/api-docs
new file mode 100644
index 0000000000..d974dbb374
--- /dev/null
+++ b/docs/client-server/swagger_matrix/api-docs
@@ -0,0 +1,38 @@
+{
+  "apiVersion": "1.0.0",
+  "swaggerVersion": "1.2",
+  "apis": [
+    {
+      "path": "/login",
+      "description": "Login operations"
+    },
+    {
+      "path": "/registration",
+      "description": "Registration operations"
+    },
+    {
+      "path": "/rooms",
+      "description": "Room operations"
+    },
+    {
+      "path": "/profile",
+      "description": "Profile operations"
+    },
+    {
+      "path": "/presence",
+      "description": "Presence operations"
+    }
+  ],
+  "authorizations": {
+    "token": {
+      "scopes": []
+    }
+  },
+  "info": {
+    "title": "Matrix Client-Server API Reference",
+    "description": "This contains the client-server API for the reference implementation of the home server",
+    "termsOfServiceUrl": "http://matrix.org",
+    "license": "Apache 2.0",
+    "licenseUrl": "http://www.apache.org/licenses/LICENSE-2.0.html"
+  }
+}