From 9a40d7bf47a2be33daca9afd819acd2769ff2bd3 Mon Sep 17 00:00:00 2001 From: Patrick Cloke Date: Tue, 28 Jul 2020 16:02:24 -0400 Subject: [PATCH 1/5] Add information from MSC2604: Parameters for Login Fallback to the spec. --- changelogs/client_server/newsfragments/2709.new | 1 + specification/client_server_api.rst | 6 ++++++ 2 files changed, 7 insertions(+) create mode 100644 changelogs/client_server/newsfragments/2709.new diff --git a/changelogs/client_server/newsfragments/2709.new b/changelogs/client_server/newsfragments/2709.new new file mode 100644 index 00000000..0c6b8ea3 --- /dev/null +++ b/changelogs/client_server/newsfragments/2709.new @@ -0,0 +1 @@ +Document `MSC2604: Parameters for Login Fallback `_. diff --git a/specification/client_server_api.rst b/specification/client_server_api.rst index 9cf0342d..491230a0 100644 --- a/specification/client_server_api.rst +++ b/specification/client_server_api.rst @@ -1096,6 +1096,12 @@ This returns an HTML and JavaScript page which can perform the entire login process. The page will attempt to call the JavaScript function ``window.onLogin`` when login has been successfully completed. +Non-credential related parameters of the login endpoint can be provided as query +parameters, for example the ``device_id`` or ``initial_device_display_name``. +These are to be forwarded to the login endpoint during the login process. + + GET /_matrix/static/client/login/?device_id=GHTYAJCE + .. _Registration: Account registration and management From e261faf70b4af2f1d45ffc1a4a761a012d526d2e Mon Sep 17 00:00:00 2001 From: Patrick Cloke Date: Wed, 29 Jul 2020 07:10:14 -0400 Subject: [PATCH 2/5] Review comments. Co-authored-by: Travis Ralston --- changelogs/client_server/newsfragments/2709.new | 2 +- specification/client_server_api.rst | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/changelogs/client_server/newsfragments/2709.new b/changelogs/client_server/newsfragments/2709.new index 0c6b8ea3..a6b3e2a2 100644 --- a/changelogs/client_server/newsfragments/2709.new +++ b/changelogs/client_server/newsfragments/2709.new @@ -1 +1 @@ -Document `MSC2604: Parameters for Login Fallback `_. +Add a ``device_id`` parameter to login fallback per `MSC2604 `_. diff --git a/specification/client_server_api.rst b/specification/client_server_api.rst index 491230a0..55a4bfbb 100644 --- a/specification/client_server_api.rst +++ b/specification/client_server_api.rst @@ -1096,8 +1096,8 @@ This returns an HTML and JavaScript page which can perform the entire login process. The page will attempt to call the JavaScript function ``window.onLogin`` when login has been successfully completed. -Non-credential related parameters of the login endpoint can be provided as query -parameters, for example the ``device_id`` or ``initial_device_display_name``. +Non-credential parameters valid for the ``/login`` endpoint can be provided as query +string parameters here. For example:: These are to be forwarded to the login endpoint during the login process. GET /_matrix/static/client/login/?device_id=GHTYAJCE From 4353f346b6c2a55cd670def8a442a9c144eaf8fd Mon Sep 17 00:00:00 2001 From: Patrick Cloke Date: Wed, 29 Jul 2020 09:18:21 -0400 Subject: [PATCH 3/5] Rename changelog file. --- changelogs/client_server/newsfragments/{2709.new => 2709.feature} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename changelogs/client_server/newsfragments/{2709.new => 2709.feature} (100%) diff --git a/changelogs/client_server/newsfragments/2709.new b/changelogs/client_server/newsfragments/2709.feature similarity index 100% rename from changelogs/client_server/newsfragments/2709.new rename to changelogs/client_server/newsfragments/2709.feature From 4daecd0d949ca6bf5b3b9aff8922c23d9578ac62 Mon Sep 17 00:00:00 2001 From: Patrick Cloke Date: Wed, 29 Jul 2020 09:19:21 -0400 Subject: [PATCH 4/5] Remove broken formatting. --- specification/client_server_api.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/specification/client_server_api.rst b/specification/client_server_api.rst index 55a4bfbb..3c5d6b54 100644 --- a/specification/client_server_api.rst +++ b/specification/client_server_api.rst @@ -1098,7 +1098,6 @@ process. The page will attempt to call the JavaScript function Non-credential parameters valid for the ``/login`` endpoint can be provided as query string parameters here. For example:: -These are to be forwarded to the login endpoint during the login process. GET /_matrix/static/client/login/?device_id=GHTYAJCE From d41ad7638e4f786c7fbbb51de17aade49b771c77 Mon Sep 17 00:00:00 2001 From: Travis Ralston Date: Thu, 30 Jul 2020 15:28:06 -0600 Subject: [PATCH 5/5] re-add note about the login process --- specification/client_server_api.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/specification/client_server_api.rst b/specification/client_server_api.rst index 3c5d6b54..4847d837 100644 --- a/specification/client_server_api.rst +++ b/specification/client_server_api.rst @@ -1097,7 +1097,8 @@ process. The page will attempt to call the JavaScript function ``window.onLogin`` when login has been successfully completed. Non-credential parameters valid for the ``/login`` endpoint can be provided as query -string parameters here. For example:: +string parameters here. These are to be forwarded to the login endpoint during the login +process. For example:: GET /_matrix/static/client/login/?device_id=GHTYAJCE