Add 'event' to event context API
also link through to the event schemas
This commit is contained in:
parent
2ed95a9a40
commit
b2e0a855cc
2 changed files with 13 additions and 6 deletions
|
@ -67,23 +67,28 @@ paths:
|
||||||
A list of room events that happened just before the
|
A list of room events that happened just before the
|
||||||
requested event.
|
requested event.
|
||||||
items:
|
items:
|
||||||
type: object
|
allOf:
|
||||||
title: RoomEvent
|
- "$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:
|
events_after:
|
||||||
type: array
|
type: array
|
||||||
description: |-
|
description: |-
|
||||||
A list of room events that happened just after the
|
A list of room events that happened just after the
|
||||||
requested event.
|
requested event.
|
||||||
items:
|
items:
|
||||||
type: object
|
allOf:
|
||||||
title: RoomEvent
|
- "$ref": "../../event-schemas/schema/core-event-schema/room_event.yaml"
|
||||||
state:
|
state:
|
||||||
type: array
|
type: array
|
||||||
description: |-
|
description: |-
|
||||||
The state of the room at the last event returned.
|
The state of the room at the last event returned.
|
||||||
items:
|
items:
|
||||||
type: object
|
allOf:
|
||||||
title: RoomEvent
|
- "$ref": "../../event-schemas/schema/core-event-schema/state_event.yaml"
|
||||||
examples:
|
examples:
|
||||||
application/json: |-
|
application/json: |-
|
||||||
{
|
{
|
||||||
|
|
|
@ -9,6 +9,8 @@ specified event. This allows clients to get the context surrounding an event.
|
||||||
Client behaviour
|
Client behaviour
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
|
There is a single HTTP API for retrieving event context, documented below.
|
||||||
|
|
||||||
{{event_context_http_api}}
|
{{event_context_http_api}}
|
||||||
|
|
||||||
Security considerations
|
Security considerations
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue