Clarify that lazy_load_members in timeline isn't respected in /sync #2010
Conversation
| @@ -28,15 +28,17 @@ allOf: | |||
| description: |- | |||
| If `true`, enables lazy-loading of membership events. See | |||
| [Lazy-loading room members](/client-server-api/#lazy-loading-room-members) | |||
| for more information. Defaults to `false`. | |||
| for more information. Defaults to `false`. Only applies to the `/messages` | |||
There was a problem hiding this comment.
It should also apply to the /context endpoint, as listed in the "lazy-loading room members" section. I believe it would be better to only list exceptions here.
|
Are we sure this isn't a synapse bug? |
There was a problem hiding this comment.
Are we sure this isn't a synapse bug?
It seems to be part of the spec: https://spec.matrix.org/v1.12/client-server-api/#get_matrixclientv3sync says:
Lazy-loading members is only supported on a StateFilter for this endpoint
That said, I'm not convinced this is the clearest way to fix that confusion. For one thing, I don't know why we treat StateFilter and RoomEventFilter as different types, when they have exactly the same fields: I have opened #2015 to fix this.
I think probably we want words like:
Note that
/synconly supports lazy-loading members on thestatepart of aRoomFilter.
Also, please use hyperlinks when referring to endpoints, other type definitions, etc.
This one caught me out today, clarify that sync only uses
lazy_load_membersfromstate.https://github.com/element-hq/synapse/blob/develop/synapse/api/filtering.py#L240-L241
Pull Request Checklist
Signed-off-by: Brad Murray [email protected]
Preview: https://pr2010--matrix-spec-previews.netlify.app