summary refs log tree commit diff
path: root/docs/client-server/swagger_matrix/registration
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/registration
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/registration')
-rw-r--r--docs/client-server/swagger_matrix/registration75
1 files changed, 75 insertions, 0 deletions
diff --git a/docs/client-server/swagger_matrix/registration b/docs/client-server/swagger_matrix/registration
new file mode 100644
index 0000000000..ccd542d11e
--- /dev/null
+++ b/docs/client-server/swagger_matrix/registration
@@ -0,0 +1,75 @@
+{
+  "apiVersion": "1.0.0", 
+  "apis": [
+    {
+      "operations": [
+        {
+          "method": "POST", 
+          "nickname": "register", 
+          "notes": "Volatile: This API is likely to change.", 
+          "parameters": [
+            {
+              "description": "A registration request", 
+              "name": "body", 
+              "paramType": "body", 
+              "required": true, 
+              "type": "RegistrationRequest"
+            }
+          ], 
+          "responseMessages": [
+            {
+              "code": 400, 
+              "message": "No JSON object."
+            }, 
+            {
+              "code": 400, 
+              "message": "User ID must only contain characters which do not require url encoding."
+            },
+            {
+              "code": 400, 
+              "message": "User ID already taken."
+            }
+          ], 
+          "summary": "Register with the home server.", 
+          "type": "RegistrationResponse"
+        }
+      ], 
+      "path": "/register"
+    }
+  ], 
+  "basePath": "http://localhost:8080/matrix/client/api/v1", 
+  "consumes": [
+    "application/json"
+  ], 
+  "models": {
+    "RegistrationResponse": {
+      "id": "RegistrationResponse", 
+      "properties": {
+        "access_token": {
+          "description": "The access token for this user.", 
+          "type": "string"
+        }, 
+        "user_id": {
+          "description": "The fully-qualified user ID.", 
+          "type": "string"
+        }
+      }
+    }, 
+    "RegistrationRequest": {
+      "id": "RegistrationRequest", 
+      "properties": {
+        "user_id": {
+          "description": "The desired user ID. If not specified, a random user ID will be allocated.", 
+          "type": "string",
+          "required": false
+        }
+      }
+    }
+  }, 
+  "produces": [
+    "application/json"
+  ], 
+  "resourcePath": "/register", 
+  "swaggerVersion": "1.2"
+}
+