summary refs log tree commit diff
path: root/UPGRADE.rst
diff options
context:
space:
mode:
authorKegan Dougal <kegan@matrix.org>2014-09-15 15:53:05 +0100
committerKegan Dougal <kegan@matrix.org>2014-09-15 15:53:05 +0100
commit688c37ebf4357064f9d9bac01797800cade991a5 (patch)
tree028dd80df17c5ff0b38dde95b4b7f49b225da354 /UPGRADE.rst
parentBe consistent when associating keys with login types for registration/login. (diff)
downloadsynapse-688c37ebf4357064f9d9bac01797800cade991a5.tar.xz
Updated CHANGES and UPGRADE to reflect registration API changes.
Diffstat (limited to '')
-rw-r--r--UPGRADE.rst23
1 files changed, 23 insertions, 0 deletions
diff --git a/UPGRADE.rst b/UPGRADE.rst
index da2a7a0a21..44c0af7282 100644
--- a/UPGRADE.rst
+++ b/UPGRADE.rst
@@ -1,3 +1,26 @@
+Upgrading to Latest
+===================
+
+This registration API now closely matches the login API. This introduces a bit
+more backwards and forwards between the HS and the client, but this improves
+the overall flexibility of the API. You can now GET on /register to retrieve a list
+of valid registration flows. Upon choosing one, they are submitted in the same
+way as login, e.g::
+
+  {
+    type: m.login.password,
+    user: foo,
+    password: bar
+  }
+
+The default HS supports 2 flows, with and without Identity Server email
+authentication. Enabling captcha on the HS will add in an extra step to all
+flows: ``m.login.recaptcha`` which must be completed before you can transition
+to the next stage. There is a new login type: ``m.login.email.identity`` which
+contains the ``threepidCreds`` key which were previously sent in the original
+register request. For more information on this, see the specification.
+
+
 Upgrading to v0.2.0
 ===================