-
Notifications
You must be signed in to change notification settings - Fork 384
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
MSC4213: Remove server_name parameter from join
and knock
endpoints
#4213
Merged
turt2live
merged 1 commit into
matrix-org:main
from
Johennes:johannes/remove-server-name
Jan 20, 2025
+54
−0
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
# MSC4213: Remove `server_name` parameter | ||
|
||
[MSC4156] deprecated the `server_name` parameter on [`/_matrix/client/v3/join/{roomIdOrAlias}`] | ||
and [`/_matrix/client/v3/knock/{roomIdOrAlias}`] in favor of a new parameter `via`. This change | ||
shipped in [Matrix v1.12]. In line with the [deprecation policy], the `server_name` parameter | ||
is now eligible for removal from the spec. | ||
|
||
|
||
## Proposal | ||
|
||
The deprecated `server_name` parameter is removed from [`/_matrix/client/v3/join/{roomIdOrAlias}`] | ||
and [`/_matrix/client/v3/knock/{roomIdOrAlias}`]. | ||
clokep marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
|
||
## Potential issues | ||
|
||
None. Servers can continue advertising support for earlier versions of the spec that included | ||
`server_name` via [`/_matrix/client/versions`]. | ||
|
||
As of writing, the following stable implementations of [MSC4156] are known to the author: | ||
|
||
- synapse: https://github.com/element-hq/synapse/pull/17650 | ||
- dendrite: https://github.com/matrix-org/dendrite/pull/3438 | ||
- matrix-js-sdk: https://github.com/matrix-org/matrix-js-sdk/pull/4381 | ||
richvdh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- ruma: https://github.com/ruma/ruma/pull/1891 | ||
- trixnity: https://gitlab.com/trixnity/trixnity/-/merge_requests/478 | ||
|
||
|
||
## Alternatives | ||
|
||
None. | ||
|
||
|
||
## Security considerations | ||
|
||
None. | ||
|
||
|
||
## Unstable prefix | ||
|
||
None. | ||
|
||
|
||
## Dependencies | ||
|
||
None. | ||
|
||
|
||
[`/_matrix/client/v3/join/{roomIdOrAlias}`]: https://spec.matrix.org/v1.12/client-server-api/#post_matrixclientv3joinroomidoralias | ||
[`/_matrix/client/v3/knock/{roomIdOrAlias}`]: https://spec.matrix.org/v1.12/client-server-api/#post_matrixclientv3knockroomidoralias | ||
[`/_matrix/client/versions`]: https://spec.matrix.org/v1.10/client-server-api/#get_matrixclientversions | ||
[Matrix v1.12]: https://spec.matrix.org/v1.12/changelog/v1.12/ | ||
[MSC4156]: https://github.com/matrix-org/matrix-spec-proposals/pull/4156 | ||
[deprecation policy]: https://spec.matrix.org/v1.12/#deprecation-policy |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Implementation requirements:
I'm tempted to mirror #4127 (comment) and say "none", but am second-guessing that MSC's requirements too. It might be beneficial to have evidence that developers are picking up the newer approaches before suggesting removal from the spec.
Thoughts very welcome.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It might not count because they were all created by me but there are five implementations linked in the proposal's body, four of which have already landed.