Unify v1 and v2 event schemas

2015-12-01 17:23:58 +00:00 · 2015-12-01 17:23:58 +00:00 · aa4ed10821
commit aa4ed10821
parent d2185d11df
35 changed files with 88 additions and 110 deletions
--- a/event-schemas/examples/m.call.answer
+++ b/event-schemas/examples/m.call.answer
@ -13,5 +13,5 @@
  "event_id": "$WLGTSEFSEF:localhost",
  "type": "m.call.answer",
  "room_id": "!Cuyf34gef24t:localhost",
-  "user_id": "@example:localhost"
+  "sender": "@example:localhost"
 }
--- a/event-schemas/examples/m.call.candidates
+++ b/event-schemas/examples/m.call.candidates
@ -15,5 +15,5 @@
  "event_id": "$WLGTSEFSEF:localhost",
  "type": "m.call.candidates",
  "room_id": "!Cuyf34gef24t:localhost",
-  "user_id": "@example:localhost"
+  "sender": "@example:localhost"
 }
--- a/event-schemas/examples/m.call.hangup
+++ b/event-schemas/examples/m.call.hangup
@ -8,5 +8,5 @@
  "event_id": "$WLGTSEFSEF:localhost",
  "type": "m.call.hangup",
  "room_id": "!Cuyf34gef24t:localhost",
-  "user_id": "@example:localhost"
+  "sender": "@example:localhost"
 }
--- a/event-schemas/examples/m.call.invite
+++ b/event-schemas/examples/m.call.invite
@ -13,5 +13,5 @@
  "event_id": "$WLGTSEFSEF:localhost",
  "type": "m.call.invite",
  "room_id": "!Cuyf34gef24t:localhost",
-  "user_id": "@example:localhost"
+  "sender": "@example:localhost"
 }
--- a/event-schemas/examples/m.room.aliases
+++ b/event-schemas/examples/m.room.aliases
@ -8,5 +8,5 @@
  "event_id": "$WLGTSEFSEF:localhost",
  "type": "m.room.aliases",
  "room_id": "!Cuyf34gef24t:localhost",
-  "user_id": "@example:localhost"
+  "sender": "@example:localhost"
 }
--- a/event-schemas/examples/m.room.avatar
+++ b/event-schemas/examples/m.room.avatar
@ -14,5 +14,5 @@
  "type": "m.room.avatar",
  "state_key": "",
  "room_id": "!Cuyf34gef24t:localhost",
-  "user_id": "@example:localhost"
+  "sender": "@example:localhost"
 }
--- a/event-schemas/examples/m.room.canonical_alias
+++ b/event-schemas/examples/m.room.canonical_alias
@ -8,5 +8,5 @@
  "event_id": "$WLGTSEFSEF:localhost",
  "type": "m.room.canonical_alias",
  "room_id": "!Cuyf34gef24t:localhost",
-  "user_id": "@example:localhost"
+  "sender": "@example:localhost"
 }
--- a/event-schemas/examples/m.room.create
+++ b/event-schemas/examples/m.room.create
@ -8,5 +8,5 @@
  "event_id": "$WLGTSEFSEF:localhost",
  "type": "m.room.create",
  "room_id": "!Cuyf34gef24t:localhost",
-  "user_id": "@example:localhost"
+  "sender": "@example:localhost"
 }
--- a/event-schemas/examples/m.room.guest_access
+++ b/event-schemas/examples/m.room.guest_access
@ -8,5 +8,5 @@
  "event_id": "$WLGTSEFSEG:localhost",
  "type": "m.room.guest_access",
  "room_id": "!Cuyf34gef24u:localhost",
-  "user_id": "@example:localhost"
+  "sender": "@example:localhost"
 }
--- a/event-schemas/examples/m.room.history_visibility
+++ b/event-schemas/examples/m.room.history_visibility
@ -8,5 +8,5 @@
  "event_id": "$WLGTSEFSEF:localhost",
  "type": "m.room.history_visibility",
  "room_id": "!Cuyf34gef24t:localhost",
-  "user_id": "@example:localhost"
+  "sender": "@example:localhost"
 }
--- a/event-schemas/examples/m.room.join_rules
+++ b/event-schemas/examples/m.room.join_rules
@ -8,5 +8,5 @@
  "event_id": "$WLGTSEFSEF:localhost",
  "type": "m.room.join_rules",
  "room_id": "!Cuyf34gef24t:localhost",
-  "user_id": "@example:localhost"
+  "sender": "@example:localhost"
 }
--- a/event-schemas/examples/m.room.member
+++ b/event-schemas/examples/m.room.member
@ -26,5 +26,5 @@
  "event_id": "$WLGTSEFSEF:localhost",
  "type": "m.room.member",
  "room_id": "!Cuyf34gef24t:localhost",
-  "user_id": "@example:localhost"
+  "sender": "@example:localhost"
 }
--- a/event-schemas/examples/m.room.member#invite_room_state
+++ b/event-schemas/examples/m.room.member#invite_room_state
@ -26,5 +26,5 @@
  "event_id": "$WLGTSEFSEF:localhost",
  "type": "m.room.member",
  "room_id": "!Cuyf34gef24t:localhost",
-  "user_id": "@example:localhost"
+  "sender": "@example:localhost"
 }
--- a/event-schemas/examples/m.room.member#third_party_invite
+++ b/event-schemas/examples/m.room.member#third_party_invite
@ -21,5 +21,5 @@
  "event_id": "$WLGTSEFSEF:localhost",
  "type": "m.room.member",
  "room_id": "!Cuyf34gef24t:localhost",
-  "user_id": "@example:localhost"
+  "sender": "@example:localhost"
 }
--- a/event-schemas/examples/m.room.message#m.audio
+++ b/event-schemas/examples/m.room.message#m.audio
@ -14,5 +14,5 @@
  "origin_server_ts": 1432735824653,
  "room_id": "!jEsUZKDJdhlrceRyVU:localhost",
  "type": "m.room.message",
-  "user_id": "@example:localhost"
-} 
+  "sender": "@example:localhost"
+} 
--- a/event-schemas/examples/m.room.message#m.emote
+++ b/event-schemas/examples/m.room.message#m.emote
@ -8,5 +8,5 @@
  "event_id": "$WLGTSEFSEF:localhost",
  "type": "m.room.message",
  "room_id": "!Cuyf34gef24t:localhost",
-  "user_id": "@example:localhost"
+  "sender": "@example:localhost"
 }
--- a/event-schemas/examples/m.room.message#m.file
+++ b/event-schemas/examples/m.room.message#m.file
@ -14,5 +14,5 @@
  "origin_server_ts": 1432735824653,
  "room_id": "!jEsUZKDJdhlrceRyVU:localhost",
  "type": "m.room.message",
-  "user_id": "@example:localhost"
-} 
+  "sender": "@example:localhost"
+} 
--- a/event-schemas/examples/m.room.message#m.image
+++ b/event-schemas/examples/m.room.message#m.image
@ -15,5 +15,5 @@
  "event_id": "$WLGTSEFSEF:localhost",
  "type": "m.room.message",
  "room_id": "!Cuyf34gef24t:localhost",
-  "user_id": "@example:localhost"
+  "sender": "@example:localhost"
 }
--- a/event-schemas/examples/m.room.message#m.location
+++ b/event-schemas/examples/m.room.message#m.location
@ -16,5 +16,5 @@
  "origin_server_ts": 1432735824653,
  "room_id": "!jEsUZKDJdhlrceRyVU:localhost",
  "type": "m.room.message",
-  "user_id": "@example:localhost"
+  "sender": "@example:localhost"
 } 
--- a/event-schemas/examples/m.room.message#m.notice
+++ b/event-schemas/examples/m.room.message#m.notice
@ -8,5 +8,5 @@
  "event_id": "$WLGTSEFSEF:localhost",
  "type": "m.room.message",
  "room_id": "!Cuyf34gef24t:localhost",
-  "user_id": "@example:localhost"
+  "sender": "@example:localhost"
 }
--- a/event-schemas/examples/m.room.message#m.text
+++ b/event-schemas/examples/m.room.message#m.text
@ -8,5 +8,5 @@
  "event_id": "$WLGTSEFSEF:localhost",
  "type": "m.room.message",
  "room_id": "!Cuyf34gef24t:localhost",
-  "user_id": "@example:localhost"
+  "sender": "@example:localhost"
 }
--- a/event-schemas/examples/m.room.message#m.video
+++ b/event-schemas/examples/m.room.message#m.video
@ -23,5 +23,5 @@
  "origin_server_ts": 1432735824653,
  "room_id": "!jEsUZKDJdhlrceRyVU:localhost",
  "type": "m.room.message",
-  "user_id": "@example:localhost"
-} 
+  "sender": "@example:localhost"
+} 
--- a/event-schemas/examples/m.room.message.feedback
+++ b/event-schemas/examples/m.room.message.feedback
@ -8,5 +8,5 @@
  "event_id": "$WLGTSEFSEF:localhost",
  "type": "m.room.message.feedback",
  "room_id": "!Cuyf34gef24t:localhost",
-  "user_id": "@example:localhost"
+  "sender": "@example:localhost"
 }
--- a/event-schemas/examples/m.room.name
+++ b/event-schemas/examples/m.room.name
@ -8,5 +8,5 @@
  "event_id": "$WLGTSEFSEF:localhost",
  "type": "m.room.name",
  "room_id": "!Cuyf34gef24t:localhost",
-  "user_id": "@example:localhost"
+  "sender": "@example:localhost"
 }
--- a/event-schemas/examples/m.room.power_levels
+++ b/event-schemas/examples/m.room.power_levels
@ -20,5 +20,5 @@
  "event_id": "$WLGTSEFSEF:localhost",
  "type": "m.room.power_levels",
  "room_id": "!Cuyf34gef24t:localhost",
-  "user_id": "@example:localhost"
+  "sender": "@example:localhost"
 }
--- a/event-schemas/examples/m.room.redaction
+++ b/event-schemas/examples/m.room.redaction
@ -8,5 +8,5 @@
  "type": "m.room.redaction",
  "room_id": "!Cuyf34gef24t:localhost",
  "redacts": "!fukweghifu23:localhost",
-  "user_id": "@example:localhost"
+  "sender": "@example:localhost"
 }
--- a/event-schemas/examples/m.room.topic
+++ b/event-schemas/examples/m.room.topic
@ -8,5 +8,5 @@
  "event_id": "$WLGTSEFSEF:localhost",
  "type": "m.room.topic",
  "room_id": "!Cuyf34gef24t:localhost",
-  "user_id": "@example:localhost"
+  "sender": "@example:localhost"
 }
--- a/event-schemas/examples/m.typing
+++ b/event-schemas/examples/m.typing
@ -4,4 +4,4 @@
    "content": {
        "user_ids": ["@alice:matrix.org", "@bob:example.com"]
    }
-}
+}
--- a/event-schemas/schema/core-event-schema/room_event.json
+++ b/event-schemas/schema/core-event-schema/room_event.json
@ -1,23 +1,41 @@
 {
  "type": "object",
  "title": "Room Event",
-  "description": "In addition to the Event fields, Room Events MUST have the following additional field.",
+  "description": "In addition to the Event fields, Room Events may have the following additional fields.",
  "allOf":[{
    "$ref": "event.json"
  }],
  "properties": {
-    "room_id": {
-      "type": "string",
-      "description": "The ID of the room associated with this event."
-    },
    "event_id": {
      "type": "string",
-      "description": "The globally unique event identifier."
+      "description": "Required. The globally unique event identifier."
    },
-    "user_id": {
+    "room_id": {
      "type": "string",
-      "description": "Contains the fully-qualified ID of the user who *sent* this event."
+      "description": "Required. The ID of the room associated with this event."
+    },
+    "sender": {
+      "type": "string",
+      "description": "Required. Contains the fully-qualified ID of the user who *sent* this event."
+    },
+    "unsigned": {
+      "type": "object",
+      "description": "Contains optional extra information about the event.",
+      "properties": {
+        "age": {
+          "type": "integer",
+          "description": "The time in milliseconds that has elapsed since the event was sent"
+        },
+        "redacted_because": {
+          "type": "string",
+          "description": "The reason this event was redacted, if it was redacted"
+        },
+        "transaction_id": {
+          "type": "string",
+          "description": "The client-supplied transaction ID, if the client being given the event is the same one which sent it."
+        }
+      }
    }
  },
-  "required": ["room_id"]
+  "required": ["event_id", "room_id", "sender"]
 }