summary refs log tree commit diff
path: root/docs/client-server/swagger_matrix/api-docs-login
diff options
context:
space:
mode:
authorKegan Dougal <kegan@matrix.org>2014-09-03 10:58:53 +0100
committerKegan Dougal <kegan@matrix.org>2014-09-03 10:58:53 +0100
commit3a3fadcece2f90171d82aee1b44956bb4b383549 (patch)
tree93e8fa7cf1eb496a556c4140a4831e25e35315a6 /docs/client-server/swagger_matrix/api-docs-login
parentUpdate port numbers. (diff)
downloadsynapse-3a3fadcece2f90171d82aee1b44956bb4b383549.tar.xz
Make API docs not lie on registration/login.
Diffstat (limited to 'docs/client-server/swagger_matrix/api-docs-login')
-rw-r--r--docs/client-server/swagger_matrix/api-docs-login22
1 files changed, 20 insertions, 2 deletions
diff --git a/docs/client-server/swagger_matrix/api-docs-login b/docs/client-server/swagger_matrix/api-docs-login
index 77a588a68e..d6f8d84f29 100644
--- a/docs/client-server/swagger_matrix/api-docs-login
+++ b/docs/client-server/swagger_matrix/api-docs-login
@@ -8,7 +8,7 @@
           "nickname": "get_login_info", 
           "notes": "All login stages MUST be mentioned if there is >1 login type.", 
           "summary": "Get the login mechanism to use when logging in.", 
-          "type": "LoginInfo"
+          "type": "LoginFlows"
         }, 
         {
           "method": "POST", 
@@ -45,12 +45,26 @@
     "application/json"
   ], 
   "models": {
+    "LoginFlows": {
+      "id": "LoginFlows",
+      "properties": {
+        "flows": {
+          "description": "A list of valid login flows.",
+          "type": "array",
+          "items": {
+            "$ref": "LoginInfo"
+          }
+        }
+      }
+    },
     "LoginInfo": {
       "id": "LoginInfo", 
       "properties": {
         "stages": {
           "description": "Multi-stage login only: An array of all the login types required to login.", 
-          "format": "string", 
+          "items": {
+            "$ref": "string"
+          }, 
           "type": "array"
         }, 
         "type": {
@@ -65,6 +79,10 @@
         "access_token": {
           "description": "The access token for this user's login if this is the final stage of the login process.", 
           "type": "string"
+        },
+        "user_id": {
+          "description": "The user's fully-qualified user ID.",
+          "type": "string"
         }, 
         "next": {
           "description": "Multi-stage login only: The next login type to submit.",