summary refs log tree commit diff
diff options
context:
space:
mode:
authorPatrick Cloke <clokep@users.noreply.github.com>2023-06-01 08:21:37 -0400
committerGitHub <noreply@github.com>2023-06-01 08:21:37 -0400
commita273561c2247ee433f97a31961a30ab00ab19574 (patch)
treee6b3e11a89b157ca55917685d6b1fe79d751541c
parentSpeed up background jobs populate_full_user_id_user_filters and populate_full... (diff)
downloadsynapse-a273561c2247ee433f97a31961a30ab00ab19574.tar.xz
Add a note about deprecating /register with a user property. (#15703)
Application services providing a "user" property (instead of "username") for
the /register endpoint was never specified. Deprecate this very old
fallback.
-rw-r--r--changelog.d/15703.removal1
-rw-r--r--docs/upgrade.md11
2 files changed, 12 insertions, 0 deletions
diff --git a/changelog.d/15703.removal b/changelog.d/15703.removal
new file mode 100644
index 0000000000..95a2d8e484
--- /dev/null
+++ b/changelog.d/15703.removal
@@ -0,0 +1 @@
+Deprecate calling the `/register` endpoint with an unspecced `user` property for application services.
diff --git a/docs/upgrade.md b/docs/upgrade.md
index af999dd91f..49ab00c057 100644
--- a/docs/upgrade.md
+++ b/docs/upgrade.md
@@ -88,6 +88,17 @@ process, for example:
     dpkg -i matrix-synapse-py3_1.3.0+stretch1_amd64.deb
     ```
 
+# Upgrading to v1.85.0
+
+## Application service registration with "user" property deprecation
+
+Application services should ensure they call the `/register` endpoint with a
+`username` property. The legacy `user` property is considered deprecated and
+should no longer be included.
+
+A future version of Synapse (v1.88.0 or later) will remove support for legacy
+application service login.
+
 # Upgrading to v1.84.0
 
 ## Deprecation of `worker_replication_*` configuration settings