Skip to content

Commit 03197ed

Browse files
authored
MSC4213: Remove server_name parameter (#4213)
Signed-off-by: Johannes Marbach <[email protected]>
1 parent 51ebe01 commit 03197ed

File tree

1 file changed

+54
-0
lines changed

1 file changed

+54
-0
lines changed

proposals/4213-remove-server-name.md

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# MSC4213: Remove `server_name` parameter
2+
3+
[MSC4156] deprecated the `server_name` parameter on [`/_matrix/client/v3/join/{roomIdOrAlias}`]
4+
and [`/_matrix/client/v3/knock/{roomIdOrAlias}`] in favor of a new parameter `via`. This change
5+
shipped in [Matrix v1.12]. In line with the [deprecation policy], the `server_name` parameter
6+
is now eligible for removal from the spec.
7+
8+
9+
## Proposal
10+
11+
The deprecated `server_name` parameter is removed from [`/_matrix/client/v3/join/{roomIdOrAlias}`]
12+
and [`/_matrix/client/v3/knock/{roomIdOrAlias}`].
13+
14+
15+
## Potential issues
16+
17+
None. Servers can continue advertising support for earlier versions of the spec that included
18+
`server_name` via [`/_matrix/client/versions`].
19+
20+
As of writing, the following stable implementations of [MSC4156] are known to the author:
21+
22+
- synapse: https://github.com/element-hq/synapse/pull/17650
23+
- dendrite: https://github.com/matrix-org/dendrite/pull/3438
24+
- matrix-js-sdk: https://github.com/matrix-org/matrix-js-sdk/pull/4381
25+
- ruma: https://github.com/ruma/ruma/pull/1891
26+
- trixnity: https://gitlab.com/trixnity/trixnity/-/merge_requests/478
27+
28+
29+
## Alternatives
30+
31+
None.
32+
33+
34+
## Security considerations
35+
36+
None.
37+
38+
39+
## Unstable prefix
40+
41+
None.
42+
43+
44+
## Dependencies
45+
46+
None.
47+
48+
49+
[`/_matrix/client/v3/join/{roomIdOrAlias}`]: https://spec.matrix.org/v1.12/client-server-api/#post_matrixclientv3joinroomidoralias
50+
[`/_matrix/client/v3/knock/{roomIdOrAlias}`]: https://spec.matrix.org/v1.12/client-server-api/#post_matrixclientv3knockroomidoralias
51+
[`/_matrix/client/versions`]: https://spec.matrix.org/v1.10/client-server-api/#get_matrixclientversions
52+
[Matrix v1.12]: https://spec.matrix.org/v1.12/changelog/v1.12/
53+
[MSC4156]: https://github.com/matrix-org/matrix-spec-proposals/pull/4156
54+
[deprecation policy]: https://spec.matrix.org/v1.12/#deprecation-policy

0 commit comments

Comments
 (0)