From 7820771fddbcd6008313fb65cea88786cabfdc00 Mon Sep 17 00:00:00 2001
From: Johannes Marbach <n0-0ne+github@mailbox.org>
Date: Tue, 25 Jun 2024 16:40:21 +0200
Subject: [PATCH] Clarify that room avatars cannot be encrypted (#1871)

Fixes: #562
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
---
 .../newsfragments/1871.clarification          |  1 +
 .../msgtype_infos/avatar_info.yaml            | 28 +++++++++++++++++++
 data/event-schemas/schema/m.room.avatar.yaml  |  2 +-
 3 files changed, 30 insertions(+), 1 deletion(-)
 create mode 100644 changelogs/client_server/newsfragments/1871.clarification
 create mode 100644 data/event-schemas/schema/core-event-schema/msgtype_infos/avatar_info.yaml

diff --git a/changelogs/client_server/newsfragments/1871.clarification b/changelogs/client_server/newsfragments/1871.clarification
new file mode 100644
index 00000000..fec9054e
--- /dev/null
+++ b/changelogs/client_server/newsfragments/1871.clarification
@@ -0,0 +1 @@
+Clarify that room avatars cannot be encrypted.
diff --git a/data/event-schemas/schema/core-event-schema/msgtype_infos/avatar_info.yaml b/data/event-schemas/schema/core-event-schema/msgtype_infos/avatar_info.yaml
new file mode 100644
index 00000000..c21dfb48
--- /dev/null
+++ b/data/event-schemas/schema/core-event-schema/msgtype_infos/avatar_info.yaml
@@ -0,0 +1,28 @@
+description: Metadata about an avatar image.
+properties:
+  h:
+    description: |-
+      The intended display height of the image in pixels. This may
+      differ from the intrinsic dimensions of the image file.
+    type: integer
+  w:
+    description: |-
+      The intended display width of the image in pixels. This may
+      differ from the intrinsic dimensions of the image file.
+    type: integer
+  mimetype:
+    description: The mimetype of the image, e.g. `image/jpeg`.
+    type: string
+  size:
+    description: Size of the image in bytes.
+    type: integer
+  thumbnail_url:
+    description: |-
+      The URL (typically [`mxc://` URI](/client-server-api/#matrix-content-mxc-uris)) to a thumbnail of the image.
+    type: string
+  thumbnail_info:
+    allOf:
+      - $ref: thumbnail_info.yaml
+    description: Metadata about the image referred to in `thumbnail_url`.
+title: AvatarInfo
+type: object
diff --git a/data/event-schemas/schema/m.room.avatar.yaml b/data/event-schemas/schema/m.room.avatar.yaml
index a4777af4..5c6c7140 100644
--- a/data/event-schemas/schema/m.room.avatar.yaml
+++ b/data/event-schemas/schema/m.room.avatar.yaml
@@ -7,7 +7,7 @@ properties:
     properties:
       info:
         allOf:
-          - $ref: core-event-schema/msgtype_infos/image_info.yaml
+          - $ref: core-event-schema/msgtype_infos/avatar_info.yaml
         description: Metadata about the image referred to in `url`.
       url:
         description: |-