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

Fix schema of m.receipt EDU (#1636)

Browse source 
It was missing a nesting level for the user ID -> user read receipt map.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
This commit is contained in:
Kévin Commaille 2023-09-19 17:52:18 +02:00 • committed by GitHub
parent 46447e0287
commit 96f88e035c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 39 additions and 34 deletions
Download patch file Download diff file Expand all files Collapse all files

1
changelogs/server_server/newsfragments/1636.clarification Normal file
View file

@ -0,0 +1 @@
Fix schema of `m.receipt` EDU.

72
data/api/server-server/definitions/event-schemas/m.receipt.yaml
View file

@ -41,41 +41,45 @@ allOf:
# on. At that point, m.read can become optional (maybe). # on. At that point, m.read can become optional (maybe).
"m.read": "m.read":
type: object type: object
description: Read receipts for users in the room. description: |-
title: User Read Receipt Read receipts for users in the room. The string key is the user
properties: ID the receipt belongs to.
event_ids: additionalProperties:
type: array type: object
description: |- title: User Read Receipt
The extremity event IDs that the user has read up to. properties:
minItems: 1 event_ids:
maxItems: 1 type: array
items: description: |-
type: string The extremity event IDs that the user has read up to.
example: ['$read_this_event:matrix.org'] minItems: 1
data: maxItems: 1
type: object items:
description: Metadata for the read receipt. type: string
title: Read Receipt Metadata example: ['$read_this_event:matrix.org']
properties: data:
ts: type: object
type: integer description: Metadata for the read receipt.
format: int64 title: Read Receipt Metadata
description: |- properties:
A POSIX timestamp in milliseconds for when the user read ts:
the event specified in the read receipt. type: integer
example: 1533358089009 format: int64
thread_id:
type: string
x-addedInMatrixVersion: "1.4"
description: |- description: |-
The root thread event's ID (or `main`) for which A POSIX timestamp in milliseconds for when the user read
thread this receipt is intended to be under. If the event specified in the read receipt.
not specified, the read receipt is *unthreaded* example: 1533358089009
(default). thread_id:
example: "$threadroot" type: string
required: ['ts'] x-addedInMatrixVersion: "1.4"
required: ['event_ids', 'data'] description: |-
The root thread event's ID (or `main`) for which
thread this receipt is intended to be under. If
not specified, the read receipt is *unthreaded*
(default).
example: "$threadroot"
required: ['ts']
required: ['event_ids', 'data']
required: ['m.read'] required: ['m.read']
example: { example: {
"!some_room:example.org": { "!some_room:example.org": {