diff --git a/changelogs/client_server/newsfragments/1284.clarification b/changelogs/client_server/newsfragments/1284.clarification new file mode 100644 index 00000000..bd52dbd4 --- /dev/null +++ b/changelogs/client_server/newsfragments/1284.clarification @@ -0,0 +1 @@ +Improve documentation about ephemeral events. \ No newline at end of file diff --git a/data/api/client-server/definitions/sync_filter.yaml b/data/api/client-server/definitions/sync_filter.yaml index 0b4a8dca..0ea6e9c2 100644 --- a/data/api/client-server/definitions/sync_filter.yaml +++ b/data/api/client-server/definitions/sync_filter.yaml @@ -62,8 +62,9 @@ properties: ephemeral: allOf: - $ref: room_event_filter.yaml - description: The events that aren't recorded in the room history, e.g. typing - and receipts, to include for rooms. + description: The ephemeral events to include for rooms. These are the + events that appear in the `ephemeral` property in the `/sync` + response. include_leave: description: Include rooms that the user has left in the sync, default false type: boolean diff --git a/data/api/client-server/sync.yaml b/data/api/client-server/sync.yaml index c36bafdb..487a7019 100644 --- a/data/api/client-server/sync.yaml +++ b/data/api/client-server/sync.yaml @@ -219,9 +219,11 @@ paths: title: Ephemeral type: object description: |- - The ephemeral events in the room that aren't - recorded in the timeline or state of the room. - e.g. typing. + The new ephemeral events in the room (events that + aren't recorded in the timeline or state of the + room). In this version of the spec, these are + [typing notification](#typing-notifications) and + [read receipt](#receipts) events. allOf: - $ref: "definitions/event_batch.yaml" account_data: