Wording tidyup

pull/3631/head
Will Hunt 6 years ago
parent 29f02edb2c
commit 2b75da81ee

@ -11,9 +11,8 @@ invites on their own do not present much context. With this endpoint, a client c
rooms you have in common before you accept an invite. rooms you have in common before you accept an invite.
While this information can be determined if the user has full access to member state for all rooms, While this information can be determined if the user has full access to member state for all rooms,
modern clients tend to implement "lazy-loaded" design patterns, so they often only have state for the modern clients often implement "lazy-loadeding", so they often only have state for a subset of all rooms
rooms the user has interacted with, or at least a subset of all rooms they are in. Therefore, the homeserver the user is in. Therefore, the homeserver should have a means to provide this information.
should have a means to provide this information.
This proposal aims to implement a simple mechanism to fetch rooms you have in common with another user. This proposal aims to implement a simple mechanism to fetch rooms you have in common with another user.
@ -41,8 +40,8 @@ GET _matrix/client/unstable/users/@alice:example.com/shared_rooms/@bob:example.c
## Potential issues ## Potential issues
Homeserver performance OR storage may be impacted by this endpoint. While a homeserver already stores Homeserver performance and storage may be impacted by this endpoint. While a homeserver already stores
membership information for each of it's users, the information may not be stored in a way that is quickly membership information for each of its users, the information may not be stored in a way that is readily
accessible. Homeservers that have implemented [POST /user-directory/search](https://matrix.org/docs/spec/client_server/r0.6.0#post-matrix-client-r0-user-directory-search) accessible. Homeservers that have implemented [POST /user-directory/search](https://matrix.org/docs/spec/client_server/r0.6.0#post-matrix-client-r0-user-directory-search)
may have started some of this work, if they are limiting users to searching for users for which they may have started some of this work, if they are limiting users to searching for users for which they
share rooms. While this is not a given by any means, it may mean that implementations of this API share rooms. While this is not a given by any means, it may mean that implementations of this API
@ -59,8 +58,8 @@ as well as include lots of extranious information.
## Security considerations ## Security considerations
The information provided in this endpoint is also accessible to day, if the client is in posession of all The information provided in this endpoint is already accessible to the client, if the client has a copy of all
state that the user can see. This endpoint only makes it possible to view this information without having state that the user can see. This endpoint only makes it possible to get this information without having
to request all state ahead of time. to request all state ahead of time.
@ -70,4 +69,3 @@ The implementation MUST use `/_matrix/client/unstable/users/{user_id}/shared_roo
The /versions endpoint MUST include a new key in `unstable_features` with the name `uk.half-shot.msc2666`. The /versions endpoint MUST include a new key in `unstable_features` with the name `uk.half-shot.msc2666`.
Once the MSC has been merged, clients should use `/_matrix/client/r0/users/{user_id}/shared_rooms/{other_user_id}` Once the MSC has been merged, clients should use `/_matrix/client/r0/users/{user_id}/shared_rooms/{other_user_id}`
and will no longer need to check for the `unstable_features` flag. and will no longer need to check for the `unstable_features` flag.

Loading…
Cancel
Save