wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

improve documentation of ephemeral events (#1284)

Browse source
This commit is contained in:
Hubert Chathi 2022-11-17 02:53:15 -05:00 • committed by GitHub
parent 64922771d4
commit 2fcc92c2fb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 9 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

1
changelogs/client_server/newsfragments/1284.clarification Normal file
View file

@ -0,0 +1 @@
Improve documentation about ephemeral events.

5
data/api/client-server/definitions/sync_filter.yaml
View file

@ -62,8 +62,9 @@ properties:
ephemeral: ephemeral:
allOf: allOf:
- $ref: room_event_filter.yaml - $ref: room_event_filter.yaml
description: The events that aren't recorded in the room history, e.g. typing description: The ephemeral events to include for rooms. These are the
and receipts, to include for rooms. events that appear in the `ephemeral` property in the `/sync`
response.
include_leave: include_leave:
description: Include rooms that the user has left in the sync, default false description: Include rooms that the user has left in the sync, default false
type: boolean type: boolean

8
data/api/client-server/sync.yaml
View file

@ -219,9 +219,11 @@ paths:
title: Ephemeral title: Ephemeral
type: object type: object
description: |- description: |-
The ephemeral events in the room that aren't The new ephemeral events in the room (events that
recorded in the timeline or state of the room. aren't recorded in the timeline or state of the
e.g. typing. room). In this version of the spec, these are
[typing notification](#typing-notifications) and
[read receipt](#receipts) events.
allOf: allOf:
- $ref: "definitions/event_batch.yaml" - $ref: "definitions/event_batch.yaml"
account_data: account_data: