From 469e75dfb6035d22c1effa3ec62bf5c7c4d181cd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?K=C3=A9vin=20Commaille?= Date: Tue, 12 Sep 2023 16:18:33 +0200 Subject: [PATCH 1/4] Fix schema of `m.receipt` EDU MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit It was missing a nesting level for the user ID -> user read receipt map. Signed-off-by: Kévin Commaille --- .../definitions/event-schemas/m.receipt.yaml | 68 ++++++++++--------- 1 file changed, 35 insertions(+), 33 deletions(-) diff --git a/data/api/server-server/definitions/event-schemas/m.receipt.yaml b/data/api/server-server/definitions/event-schemas/m.receipt.yaml index bbc3ac670..76cdaf11d 100644 --- a/data/api/server-server/definitions/event-schemas/m.receipt.yaml +++ b/data/api/server-server/definitions/event-schemas/m.receipt.yaml @@ -42,40 +42,42 @@ allOf: "m.read": type: object description: Read receipts for users in the room. - title: User Read Receipt - properties: - event_ids: - type: array - description: |- - The extremity event IDs that the user has read up to. - minItems: 1 - maxItems: 1 - items: - type: string - example: ['$read_this_event:matrix.org'] - data: - type: object - description: Metadata for the read receipt. - title: Read Receipt Metadata - properties: - ts: - type: integer - format: int64 - description: |- - A POSIX timestamp in milliseconds for when the user read - the event specified in the read receipt. - example: 1533358089009 - thread_id: - type: string - x-addedInMatrixVersion: "1.4" + additionalProperties: + type: object + title: User Read Receipt + properties: + event_ids: + type: array + description: |- + The extremity event IDs that the user has read up to. + minItems: 1 + maxItems: 1 + items: + type: string + example: ['$read_this_event:matrix.org'] + data: + type: object + description: Metadata for the read receipt. + title: Read Receipt Metadata + properties: + ts: + type: integer + format: int64 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'] + A POSIX timestamp in milliseconds for when the user read + the event specified in the read receipt. + example: 1533358089009 + thread_id: + type: string + x-addedInMatrixVersion: "1.4" + 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'] example: { "!some_room:example.org": { From 9c995dfcb6520d40372e7f5ee7004de001aefc7d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?K=C3=A9vin=20Commaille?= Date: Tue, 12 Sep 2023 16:19:57 +0200 Subject: [PATCH 2/4] Add changelog MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Kévin Commaille --- changelogs/internal/newsfragments/1636.clarification | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelogs/internal/newsfragments/1636.clarification diff --git a/changelogs/internal/newsfragments/1636.clarification b/changelogs/internal/newsfragments/1636.clarification new file mode 100644 index 000000000..9f39a014c --- /dev/null +++ b/changelogs/internal/newsfragments/1636.clarification @@ -0,0 +1 @@ +Fix schema of `m.receipt` EDU. From 80b2f40cfb5a4b38204f1c2eb35a2916b82f802b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?K=C3=A9vin=20Commaille?= Date: Tue, 19 Sep 2023 17:29:07 +0200 Subject: [PATCH 3/4] Move newsfragment MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Kévin Commaille --- .../{internal => server_server}/newsfragments/1636.clarification | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename changelogs/{internal => server_server}/newsfragments/1636.clarification (100%) diff --git a/changelogs/internal/newsfragments/1636.clarification b/changelogs/server_server/newsfragments/1636.clarification similarity index 100% rename from changelogs/internal/newsfragments/1636.clarification rename to changelogs/server_server/newsfragments/1636.clarification From df64983d407f5c1e73672a5b7523dc79ec33371a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?K=C3=A9vin=20Commaille?= Date: Tue, 19 Sep 2023 17:31:31 +0200 Subject: [PATCH 4/4] Document user ID key MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Kévin Commaille --- .../server-server/definitions/event-schemas/m.receipt.yaml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/data/api/server-server/definitions/event-schemas/m.receipt.yaml b/data/api/server-server/definitions/event-schemas/m.receipt.yaml index 76cdaf11d..0b064ff1f 100644 --- a/data/api/server-server/definitions/event-schemas/m.receipt.yaml +++ b/data/api/server-server/definitions/event-schemas/m.receipt.yaml @@ -41,7 +41,9 @@ allOf: # on. At that point, m.read can become optional (maybe). "m.read": type: object - description: Read receipts for users in the room. + description: |- + Read receipts for users in the room. The string key is the user + ID the receipt belongs to. additionalProperties: type: object title: User Read Receipt