Merge pull request #268 from matrix-org/rav/add_event_to_context

Add 'event' to event context API

api/client-server/event_context.yaml

@@ -67,23 +67,28 @@ paths:
                   A list of room events that happened just before the
                   requested event.
                 items:
-                  type: object
-                  title: RoomEvent
+                  allOf:
+                    - "$ref": "../../event-schemas/schema/core-event-schema/room_event.yaml"
+              event:
+                description: |-
+                  Details of the requested event.
+                allOf:
+                  - "$ref": "../../event-schemas/schema/core-event-schema/room_event.yaml"
               events_after:
                 type: array
                 description: |-
                   A list of room events that happened just after the
                   requested event.
                 items:
-                  type: object
-                  title: RoomEvent
+                  allOf:
+                    - "$ref": "../../event-schemas/schema/core-event-schema/room_event.yaml"
               state:
                 type: array
                 description: |-
                   The state of the room at the last event returned.
                 items:
-                  type: object
-                  title: RoomEvent
+                  allOf:
+                    - "$ref": "../../event-schemas/schema/core-event-schema/state_event.yaml"
           examples:
             application/json: |-
                 {
@@ -99,7 +104,7 @@ paths:
                       "origin_server_ts": 1446030608551,
                       "room_id": "!sCDvXTtzjpiPxaqkkt:localhost:8480",
                       "type": "m.room.message",
-                      "user_id": "@test:localhost:8480"
+                      "sender": "@test:localhost:8480"
                     }
                   ],
                   "events_before": [
@@ -113,7 +118,7 @@ paths:
                       "origin_server_ts": 1446030607984,
                       "room_id": "!sCDvXTtzjpiPxaqkkt:localhost:8480",
                       "type": "m.room.message",
-                      "user_id": "@test:localhost:8480"
+                      "sender": "@test:localhost:8480"
                     }
                   ],
                   "start": "t27-54_2_0_2",
@@ -128,7 +133,7 @@ paths:
                       "room_id": "!sCDvXTtzjpiPxaqkkt:localhost:8480",
                       "state_key": "",
                       "type": "m.room.create",
-                      "user_id": "@test:localhost:8480"
+                      "sender": "@test:localhost:8480"
                     },
                     {
                       "age": 2067105053,
@@ -143,7 +148,7 @@ paths:
                       "room_id": "!sCDvXTtzjpiPxaqkkt:localhost:8480",
                       "state_key": "@test:localhost:8480",
                       "type": "m.room.member",
-                      "user_id": "@test:localhost:8480"
+                      "sender": "@test:localhost:8480"
                     }
                   ]
                 }

specification/modules/event_context.rst

@@ -9,6 +9,8 @@ specified event. This allows clients to get the context surrounding an event.
 Client behaviour
 ----------------
 
+There is a single HTTP API for retrieving event context, documented below.
+
 {{event_context_http_api}}
 
 Security considerations