Skip to content
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

MSC4235: via query param for hierarchy endpoint #4235

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

ajbura
Copy link

@ajbura ajbura commented Dec 2, 2024

@clokep clokep changed the title server_name query param for hierarchy endpoint MSC4235: server_name query param for hierarchy endpoint Dec 2, 2024
@ajbura ajbura marked this pull request as draft December 3, 2024 11:41
@ajbura ajbura changed the title MSC4235: server_name query param for hierarchy endpoint MSC4235: via query param for hierarchy endpoint Dec 4, 2024
@ajbura ajbura marked this pull request as ready for review December 4, 2024 11:28
proposals/4235-via-query-param-for-hierarchy.md Outdated Show resolved Hide resolved
proposals/4235-via-query-param-for-hierarchy.md Outdated Show resolved Hide resolved
proposals/4235-via-query-param-for-hierarchy.md Outdated Show resolved Hide resolved
@turt2live turt2live added proposal A matrix spec change proposal client-server Client-Server API kind:maintenance MSC which clarifies/updates existing spec needs-implementation This MSC does not have a qualifying implementation for the SCT to review. The MSC cannot enter FCP. labels Dec 9, 2024

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 introduced
in [MSC2946](https://github.com/matrix-org/matrix-spec-proposals/pull/2946). This endpoint does not require user to join
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should link to the spec if possible?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it already has link to the hierarchy spec or I am missing something?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's no reason to link to the MSC then, it's confusing.

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 does not require a space room to be joined before calling this endpoint, it's possible that the requested
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How would this happen? From a room directory response? I'm unsure what user interactions would cause this.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

User interactions are implementation specific, this MSC is trying to fix the issue in the hierarchy spec. An example using the via param would be requesting the only part of sub-spaces hierarchy which is unknown the the client. I have listed some more example of how this could be helpful in the MSC itself.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
client-server Client-Server API kind:maintenance MSC which clarifies/updates existing spec needs-implementation This MSC does not have a qualifying implementation for the SCT to review. The MSC cannot enter FCP. proposal A matrix spec change proposal
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants