Add general clarity
This commit is contained in:
parent
afead2eb1b
commit
77c4c4b07c
4 changed files with 10 additions and 6 deletions
|
@ -25,7 +25,7 @@ allOf:
|
||||||
include_redundant_members:
|
include_redundant_members:
|
||||||
type: boolean
|
type: boolean
|
||||||
description: |-
|
description: |-
|
||||||
If ``true``, enables redudant membership events. Does not
|
If ``true``, enables redundant membership events. Does not
|
||||||
apply unless ``lazy_load_members`` is ``true``. See
|
apply unless ``lazy_load_members`` is ``true``. See
|
||||||
`Lazy-loading room members <#lazy-loading-room-members>`_
|
`Lazy-loading room members <#lazy-loading-room-members>`_
|
||||||
for more information. Defaults to ``false``.
|
for more information. Defaults to ``false``.
|
||||||
|
|
|
@ -40,10 +40,11 @@ paths:
|
||||||
for this endpoint. When lazy-loading is enabled, servers MUST include the
|
for this endpoint. When lazy-loading is enabled, servers MUST include the
|
||||||
syncing user's own membership event when they join a room, or when the
|
syncing user's own membership event when they join a room, or when the
|
||||||
full state of rooms is requested. The user's own membership event is eligible
|
full state of rooms is requested. The user's own membership event is eligible
|
||||||
for being considered redudant by the server. When a sync is ``limited``,
|
for being considered redundant by the server. When a sync is ``limited``,
|
||||||
the server MUST return membership events for the timeline, even if the
|
the server MUST return membership events for events in the gap (from ``since``),
|
||||||
applicable events are not in the response, regardless as to whether or not
|
even if the applicable events are not in the response, regardless as to whether
|
||||||
they are redundant.
|
or not they are redundant. ``include_redundant_members`` is ignored for limited
|
||||||
|
syncs.
|
||||||
operationId: sync
|
operationId: sync
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
|
|
|
@ -1306,6 +1306,9 @@ The current endpoints which support lazy-loading room members are:
|
||||||
* |/rooms/<room_id>/messages|_
|
* |/rooms/<room_id>/messages|_
|
||||||
* |/rooms/{roomId}/context/{eventId}|_
|
* |/rooms/{roomId}/context/{eventId}|_
|
||||||
|
|
||||||
|
API endpoints
|
||||||
|
~~~~~~~~~~~~~
|
||||||
|
|
||||||
{{filter_cs_http_api}}
|
{{filter_cs_http_api}}
|
||||||
|
|
||||||
Events
|
Events
|
||||||
|
|
|
@ -293,7 +293,7 @@ choose a name:
|
||||||
users (`disambiguating them if required`_) and concatenating them. For
|
users (`disambiguating them if required`_) and concatenating them. For
|
||||||
example, the client may choose to show "Alice, Bob, and Charlie
|
example, the client may choose to show "Alice, Bob, and Charlie
|
||||||
(@charlie:example.org)" as the room name. The client may optionally
|
(@charlie:example.org)" as the room name. The client may optionally
|
||||||
limit the number
|
limit the number of users it uses to generate a room name.
|
||||||
|
|
||||||
#. If there are fewer heroes than ``m.joined_member_count + m.invited_member_count
|
#. If there are fewer heroes than ``m.joined_member_count + m.invited_member_count
|
||||||
- 1``, and ``m.joined_member_count + m.invited_member_count`` is greater
|
- 1``, and ``m.joined_member_count + m.invited_member_count`` is greater
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue