Clarify that the url field in m.room.avatar events is not required. #…

…987)
matrix-org · Mar 22, 2022 · 1744808 · 1744808
1 parent b5cb9f7
commit 1744808
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/changelogs/client_server/newsfragments/987.clarification b/changelogs/client_server/newsfragments/987.clarification
@@ -0,0 +1 @@
+Clarify that the url field in `m.room.avatar` events is not required.
diff --git a/data/event-schemas/schema/m.room.avatar.yaml b/data/event-schemas/schema/m.room.avatar.yaml
@@ -10,10 +10,10 @@ properties:
           - $ref: core-event-schema/msgtype_infos/image_info.yaml
         description: Metadata about the image referred to in `url`.
       url:
-        description: The URL to the image.
+        description: |-
+          The URL to the image. If this property is not present, the room has no avatar. This can be useful
+          to remove a previous room avatar.
         type: string
-    required:
-      - url
     type: object
   state_key:
     description: A zero-length string.