From a273561c2247ee433f97a31961a30ab00ab19574 Mon Sep 17 00:00:00 2001
From: Patrick Cloke <clokep@users.noreply.github.com>
Date: Thu, 1 Jun 2023 08:21:37 -0400
Subject: 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.
---
 docs/upgrade.md | 11 +++++++++++
 1 file changed, 11 insertions(+)

(limited to 'docs')

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
-- 
cgit 1.5.1