From 33d738e6650037824e52ace02407dd120c0ef803 Mon Sep 17 00:00:00 2001
From: Travis Ralston <travpc@gmail.com>
Date: Sun, 31 May 2020 21:41:29 -0600
Subject: [PATCH] Document the m.room.member unsigned object in full

---
 .../core-event-schema/sync_room_event.yaml    | 19 +----------
 .../core-event-schema/unsigned_prop.yaml      | 32 +++++++++++++++++++
 event-schemas/schema/m.room.member            | 18 +++++------
 3 files changed, 42 insertions(+), 27 deletions(-)
 create mode 100644 event-schemas/schema/core-event-schema/unsigned_prop.yaml

diff --git a/event-schemas/schema/core-event-schema/sync_room_event.yaml b/event-schemas/schema/core-event-schema/sync_room_event.yaml
index 8006148f..fef13ad0 100644
--- a/event-schemas/schema/core-event-schema/sync_room_event.yaml
+++ b/event-schemas/schema/core-event-schema/sync_room_event.yaml
@@ -34,24 +34,7 @@ properties:
     type: integer
     format: int64
   unsigned:
-    description: Contains optional extra information about the event.
-    properties:
-      age:
-        description: The time in milliseconds that has elapsed since the event was
-          sent. This field is generated by the local homeserver, and may be incorrect
-          if the local time on at least one of the two servers is out of sync, which can
-          cause the age to either be negative or greater than it actually is.
-        type: integer
-      redacted_because:
-        description: Optional. The event that redacted this event, if any.
-        title: Event
-        type: object
-      transaction_id:
-        description: The client-supplied transaction ID, if the client being given
-          the event is the same one which sent it.
-        type: string
-    title: UnsignedData
-    type: object
+    $ref: unsigned_prop.yaml
 required:
 - event_id
 - sender
diff --git a/event-schemas/schema/core-event-schema/unsigned_prop.yaml b/event-schemas/schema/core-event-schema/unsigned_prop.yaml
new file mode 100644
index 00000000..39cfb267
--- /dev/null
+++ b/event-schemas/schema/core-event-schema/unsigned_prop.yaml
@@ -0,0 +1,32 @@
+# Copyright 2020 The Matrix.org Foundation C.I.C.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+title: UnsignedData
+type: object
+description: Contains optional extra information about the event.
+properties:
+  age:
+    description: The time in milliseconds that has elapsed since the event was
+      sent. This field is generated by the local homeserver, and may be incorrect
+      if the local time on at least one of the two servers is out of sync, which can
+      cause the age to either be negative or greater than it actually is.
+    type: integer
+  redacted_because:
+    description: Optional. The event that redacted this event, if any.
+    title: Event
+    type: object
+  transaction_id:
+    description: The client-supplied transaction ID, if the client being given
+      the event is the same one which sent it.
+    type: string
diff --git a/event-schemas/schema/m.room.member b/event-schemas/schema/m.room.member
index 7fe23f40..36490c6b 100644
--- a/event-schemas/schema/m.room.member
+++ b/event-schemas/schema/m.room.member
@@ -115,14 +115,14 @@ properties:
       - m.room.member
     type: string
   unsigned:
-    type: object
-    title: UnsignedData
-    description: Contains optional extra information about the event.
-    properties:
-      invite_room_state:
-        description: 'A subset of the state of the room at the time of the invite, if ``membership`` is ``invite``. Note that this state is informational, and SHOULD NOT be trusted; once the client has joined the room, it SHOULD fetch the live state from the server and discard the invite_room_state. Also, clients must not rely on any particular state being present here; they SHOULD behave properly (with possibly a degraded but not a broken experience) in the absence of any particular events here. If they are set on the room, at least the state for ``m.room.avatar``, ``m.room.canonical_alias``, ``m.room.join_rules``, and ``m.room.name`` SHOULD be included.'
-        items:
-          $ref: "stripped_state.yaml"
-        type: array
+    allOf:
+      - $ref: "core-event-schema/unsigned_prop.yaml"
+      - type: object
+        properties:
+          invite_room_state:
+            description: 'A subset of the state of the room at the time of the invite, if ``membership`` is ``invite``. Note that this state is informational, and SHOULD NOT be trusted; once the client has joined the room, it SHOULD fetch the live state from the server and discard the invite_room_state. Also, clients must not rely on any particular state being present here; they SHOULD behave properly (with possibly a degraded but not a broken experience) in the absence of any particular events here. If they are set on the room, at least the state for ``m.room.avatar``, ``m.room.canonical_alias``, ``m.room.join_rules``, and ``m.room.name`` SHOULD be included.'
+            items:
+              $ref: "stripped_state.yaml"
+            type: array
 title: The current membership state of a user in the room.
 type: object