Document user ID key

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
9 months ago · df64983d40
parent 80b2f40cfb
commit df64983d40
1 changed files with 3 additions and 1 deletions
--- 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