MSC4156: Migrate server_name to via (#1933)
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
This commit is contained in:
parent
215982abc2
commit
7f2f100420
4 changed files with 52 additions and 0 deletions
1
changelogs/client_server/newsfragments/1933.deprecation
Normal file
1
changelogs/client_server/newsfragments/1933.deprecation
Normal file
|
@ -0,0 +1 @@
|
||||||
|
Deprecate the `server_name` query parameter on `/_matrix/client/v3/join/{roomIdOrAlias}` and `/_matrix/client/v3/knock/{roomIdOrAlias}` as per [MSC4156](https://github.com/matrix-org/matrix-spec-proposals/pull/4156).
|
1
changelogs/client_server/newsfragments/1933.feature
Normal file
1
changelogs/client_server/newsfragments/1933.feature
Normal file
|
@ -0,0 +1 @@
|
||||||
|
Add `via` query parameter on `/_matrix/client/v3/join/{roomIdOrAlias}` and `/_matrix/client/v3/knock/{roomIdOrAlias}` as per [MSC4156](https://github.com/matrix-org/matrix-spec-proposals/pull/4156).
|
|
@ -139,6 +139,31 @@ paths:
|
||||||
type: string
|
type: string
|
||||||
- in: query
|
- in: query
|
||||||
name: server_name
|
name: server_name
|
||||||
|
x-changedInMatrixVersion:
|
||||||
|
"1.12": |-
|
||||||
|
This parameter has been deprecated in favour of `via` and will be removed in
|
||||||
|
a future version of the spec.
|
||||||
|
|
||||||
|
Clients SHOULD use `via` when the homeserver they're talking to supports it.
|
||||||
|
To do this, they MAY either detect server support through the supported spec
|
||||||
|
versions in [`/_matrix/client/versions`](/client-server-api/#get_matrixclientversions)
|
||||||
|
or always include both parameters with identical values.
|
||||||
|
|
||||||
|
Homeservers MUST ignore all `server_name` parameters if any `via` parameters
|
||||||
|
are supplied.
|
||||||
|
description: |-
|
||||||
|
The servers to attempt to join the room through. One of the servers
|
||||||
|
must be participating in the room.
|
||||||
|
example:
|
||||||
|
- matrix.org
|
||||||
|
- elsewhere.ca
|
||||||
|
schema:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
- in: query
|
||||||
|
name: via
|
||||||
|
x-addedInMatrixVersion: "1.12"
|
||||||
description: |-
|
description: |-
|
||||||
The servers to attempt to join the room through. One of the servers
|
The servers to attempt to join the room through. One of the servers
|
||||||
must be participating in the room.
|
must be participating in the room.
|
||||||
|
|
|
@ -50,6 +50,31 @@ paths:
|
||||||
type: string
|
type: string
|
||||||
- in: query
|
- in: query
|
||||||
name: server_name
|
name: server_name
|
||||||
|
x-changedInMatrixVersion:
|
||||||
|
"1.12": |-
|
||||||
|
This parameter has been deprecated in favour of `via` and will be removed in
|
||||||
|
a future version of the spec.
|
||||||
|
|
||||||
|
Clients SHOULD use `via` when the homeserver they're talking to supports it.
|
||||||
|
To do this, they MAY either detect server support through the supported spec
|
||||||
|
versions in [`/_matrix/client/versions`](/client-server-api/#get_matrixclientversions)
|
||||||
|
or always include both parameters with identical values.
|
||||||
|
|
||||||
|
Homeservers MUST ignore all `server_name` parameters if any `via` parameters
|
||||||
|
are supplied.
|
||||||
|
description: |-
|
||||||
|
The servers to attempt to knock on the room through. One of the servers
|
||||||
|
must be participating in the room.
|
||||||
|
example:
|
||||||
|
- matrix.org
|
||||||
|
- elsewhere.ca
|
||||||
|
schema:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
- in: query
|
||||||
|
name: via
|
||||||
|
x-addedInMatrixVersion: "1.12"
|
||||||
description: |-
|
description: |-
|
||||||
The servers to attempt to knock on the room through. One of the servers
|
The servers to attempt to knock on the room through. One of the servers
|
||||||
must be participating in the room.
|
must be participating in the room.
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue