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

MSC3266: Room summary API #3266

Open
wants to merge 35 commits into
base: old_master
Choose a base branch
from

Conversation

deepbluev7
Copy link
Contributor

@deepbluev7 deepbluev7 commented Jul 4, 2021

Rendered.

Somewhat related to MSC2946 this provides an API to get a summary for a specific room either from the local server or over federation.

Useful for a few cases, where you need to show a summary for a room like matrix.to, traveler bots, showing spaces, lightweight clients, etc.

Open design questions looking for feedback: see this comment chain: #3266 (comment) resolved as of 2021/10/06

Implementations:

Signed-off-by: Nicolas Werner [email protected]


SCT stuff:

Shepherd: @richvdh
FCP tickyboxes

Checklist: #3266 (comment)

Signed-off-by: Nicolas Werner <[email protected]>
@deepbluev7 deepbluev7 changed the title Room summary proposal MSC3266: Room summary proposal Jul 4, 2021
@deepbluev7 deepbluev7 changed the title MSC3266: Room summary proposal MSC3266: Room summary Jul 4, 2021
@turt2live turt2live added client-server Client-Server API kind:feature MSC for not-core and not-maintenance stuff 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 proposal-in-review labels Jul 5, 2021
@deepbluev7 deepbluev7 changed the title MSC3266: Room summary MSC3266: Room summary API Jul 11, 2021
Signed-off-by: Nicolas Werner <[email protected]>
…est of the path separate

Signed-off-by: Nicolas Werner <[email protected]>
That way the requesting server knows, if any user would have access to
that room and it can forward the room to the user.

Signed-off-by: Nicolas Werner <[email protected]>
As well as a few smaller clarifications.
@deepbluev7
Copy link
Contributor Author

Okay, I updated the MSC with most of the experiences I had with it from the last 2 years. Also shields.io now uses it, so does that remove your concerns regarding the unauthenticated usage, @turt2live? It apparently is a lot better than their previous approach of registering a new guest user per request.

@turt2live turt2live self-requested a review January 7, 2025 23:51
Copy link
Member

@turt2live turt2live left a comment

Choose a reason for hiding this comment

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

I haven't perfectly verified the implementation matches, especially on the server side, but this has been sitting for far too long anyways. Let's ship it.

@turt2live
Copy link
Member

@mscbot fcp merge

@mscbot
Copy link
Collaborator

mscbot commented Jan 9, 2025

Team member @turt2live has proposed to merge this. The next step is review by the rest of the tagged people:

Once at least 75% of reviewers approve (and there are no outstanding concerns), this will enter its final comment period. If you spot a major issue that hasn't been raised at any point in this process, please speak up!

See this document for information about what commands tagged team members can give me.

@mscbot mscbot added proposed-final-comment-period Currently awaiting signoff of a majority of team members in order to enter the final comment period. disposition-merge labels Jan 9, 2025
proposals/3266-room-summary.md Outdated Show resolved Hide resolved
proposals/3266-room-summary.md Outdated Show resolved Hide resolved
proposals/3266-room-summary.md Outdated Show resolved Hide resolved
proposals/3266-room-summary.md Outdated Show resolved Hide resolved
proposals/3266-room-summary.md Outdated Show resolved Hide resolved
proposals/3266-room-summary.md Outdated Show resolved Hide resolved
proposals/3266-room-summary.md Outdated Show resolved Hide resolved
proposals/3266-room-summary.md Outdated Show resolved Hide resolved
proposals/3266-room-summary.md Outdated Show resolved Hide resolved
proposals/3266-room-summary.md Show resolved Hide resolved
proposals/3266-room-summary.md Outdated Show resolved Hide resolved
proposals/3266-room-summary.md Show resolved Hide resolved
proposals/3266-room-summary.md Outdated Show resolved Hide resolved
deepbluev7 and others added 3 commits January 10, 2025 20:56
Co-authored-by: Richard van der Hoff <[email protected]>
Co-authored-by: Patrick Cloke <[email protected]>
It suffers from the same knock_restricted issue.
@ara4n
Copy link
Member

ara4n commented Jan 15, 2025

I've given this a green tick in order not to block its progress, given the MSC as a whole is definitely useful and very proven at this point. @deepbluev7 can you please deal with the remaining open PR comments though (e.g. spelling out what 'public' means; etc)?

@cyb3rko
Copy link

cyb3rko commented Jan 20, 2025

Mautrix has also implemented it now: https://github.com/mautrix/go/releases/tag/v0.23.0

proposals/3266-room-summary.md Outdated Show resolved Hide resolved
proposals/3266-room-summary.md Outdated Show resolved Hide resolved
proposals/3266-room-summary.md Outdated Show resolved Hide resolved
@richvdh richvdh self-requested a review February 7, 2025 10:32
@richvdh
Copy link
Member

richvdh commented Feb 18, 2025

This has got stuck waiting for updates once more, so in the interests of pushing it over the line, the Spec Core Team are going to make the final few updates.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
client-server Client-Server API disposition-merge kind:feature MSC for not-core and not-maintenance stuff proposal A matrix spec change proposal proposed-final-comment-period Currently awaiting signoff of a majority of team members in order to enter the final comment period.
Projects
Status: Ready for FCP ticks
Development

Successfully merging this pull request may close these issues.