-
Notifications
You must be signed in to change notification settings - Fork 416
MSC4235: via query param for hierarchy endpoint
#4235
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
Open
ajbura
wants to merge
10
commits into
matrix-org:main
Choose a base branch
from
ajbura:server-name-hierarchy
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 3 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
a66750c
add server name query param for hierarchy endpoint proposal
ajbura 0cbd27e
add msc number
ajbura ac419f8
change param name to via
ajbura e4822ae
fix typos and add link to space summary msc
ajbura 120f6a2
remove server specific issues and improve benefits
ajbura 9fd3b7c
fix typo
ajbura a9933d2
fix typo
ajbura 671ba65
remove msc mention
ajbura f16157c
add usage details
ajbura c31608a
add unstable prefix
ajbura 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 hidden or 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,35 @@ | ||
| # MSC4235: `via` query param for /hierarchy endpoint | ||
|
|
||
| To request the hierarchy of a space, clients need to call the | ||
| [/hierarchy](https://spec.matrix.org/v1.9/client-server-api/#get_matrixclientv1roomsroomidhierarchy) endpoint. This | ||
| endpoint does not require user to join the room before responding with hierarchy details. It instead check whether the | ||
| room is potentially joinable (per [MSC3173](https://github.com/matrix-org/matrix-spec-proposals/pull/3173)) before | ||
| responding. | ||
|
|
||
| Because it doesn't not require space room to be joined before calling this endpoint, It is possible that the requested | ||
| room is not locally available on the server and server need to request over federation to respond. In that case this | ||
| endpoint does not provide client to express the server name's which server need to request over federation. | ||
ajbura marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## Proposal | ||
|
|
||
| The [/hierarchy](https://spec.matrix.org/v1.9/client-server-api/#get_matrixclientv1roomsroomidhierarchy) endpoint should | ||
| include `via` as query parameter which server can use in case requested room in not locally available on the server. | ||
|
|
||
| Following change will allow clients to use this endpoint in more efficient manner, like: | ||
| 1. Requesting the only part of sub-spaces hierarchy which is unknown the the client. | ||
| 2. Rendering the preview of space and it's children before joining the space. | ||
| 3. Since server does not respect [order](https://spec.matrix.org/v1.9/client-server-api/#mspacechild) of the children in | ||
| response, client can divide the work of loading child spaces and figuring out order and re-ordering instead of | ||
| relying on the long paginated response for those action. | ||
clokep marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## Potential issues | ||
| Unknown | ||
|
|
||
| ## Alternative | ||
| Unknown | ||
|
|
||
| ## Security considerations | ||
| Unknown | ||
|
|
||
| ## Unstable prefix | ||
| None | ||
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.
Uh oh!
There was an error while loading. Please reload this page.