archive
/
matrix-spec
mirror of https://github.com/matrix-org/matrix-spec
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #165 from matrix-org/rav/flatten_sync

Browse Source 
/sync response format tweaks
pull/977/head
Richard van der Hoff 9 years ago
parent 0db055b4ea d7d59d78e1
commit e7610c7cc5
4 changed files with 43 additions and 83 deletions
Show Stats Download Patch File Download Diff File

12
api/client-server/v2_alpha/definitions/room_event_batch.json
Unescape Escape View File

@ -1,12 +0,0 @@
{
"type": "object",
"properties": {
"events": {
"type": "array",
"description": "List of event ids",
"items": {
"type": "string"
}
}
}
}

2
api/client-server/v2_alpha/definitions/timeline_batch.json
Unescape Escape View File

@ -1,6 +1,6 @@
{ {
"type": "object", "type": "object",
"allOf": [{"$ref":"definitions/room_event_batch.json"}], "allOf": [{"$ref":"definitions/event_batch.json"}],
"properties": { "properties": {
"limited": { "limited": {
"type": "boolean", "type": "boolean",

85
api/client-server/v2_alpha/sync.yaml
Unescape Escape View File

@ -95,7 +95,7 @@ paths:
description: |- description: |-
Updates to rooms. Updates to rooms.
properties: properties:
joined: join:
title: Joined Rooms title: Joined Rooms
type: object type: object
description: |- description: |-
@ -104,19 +104,6 @@ paths:
title: Joined Room title: Joined Room
type: object type: object
properties: properties:
event_map:
title: EventMap
type: object
description: |-
A map from event ID to events for this room. The
events are referenced from the ``timeline`` and
``state`` keys for this room.
additionalProperties:
title: Event
description: An event object.
type: object
allOf:
- $ref: "definitions/event.json"
state: state:
title: State title: State
type: object type: object
@ -127,7 +114,7 @@ paths:
``timeline``, if ``since`` is not given, or ``timeline``, if ``since`` is not given, or
``full_state`` is true). ``full_state`` is true).
allOf: allOf:
- $ref: "definitions/room_event_batch.json" - $ref: "definitions/event_batch.json"
timeline: timeline:
title: Timeline title: Timeline
type: object type: object
@ -145,7 +132,7 @@ paths:
e.g. typing. e.g. typing.
allOf: allOf:
- $ref: "definitions/event_batch.json" - $ref: "definitions/event_batch.json"
invited: invite:
title: Invited Rooms title: Invited Rooms
type: object type: object
description: |- description: |-
@ -172,35 +159,22 @@ paths:
``invite_state``. ``invite_state``.
allOf: allOf:
- $ref: "definitions/event_batch.json" - $ref: "definitions/event_batch.json"
archived: leave:
title: Archived rooms title: Left rooms
type: object type: object
description: |- description: |-
The rooms that the user has left or been banned from. The rooms that the user has left or been banned from.
additionalProperties: additionalProperties:
title: Archived Room title: Left Room
type: object type: object
properties: properties:
event_map:
title: EventMap
type: object
description: |-
A map from event ID to events for this room. The
events are referenced from the ``timeline`` and
``state`` keys for this room.
additionalProperties:
title: Event
description: An event object.
type: object
allOf:
- $ref: "definitions/event.json"
state: state:
title: State title: State
type: object type: object
description: |- description: |-
The state updates for the room up to the start of the timeline. The state updates for the room up to the start of the timeline.
allOf: allOf:
- $ref: "definitions/room_event_batch.json" - $ref: "definitions/event_batch.json"
timeline: timeline:
title: Timeline title: Timeline
type: object type: object
@ -230,46 +204,43 @@ paths:
] ]
}, },
"rooms": { "rooms": {
"joined": { "join": {
"!726s6s6q:example.com": { "!726s6s6q:example.com": {
"event_map": { "state": {
"$66697273743031:example.com": { "events": [
{
"sender": "@alice:example.com", "sender": "@alice:example.com",
"type": "m.room.member", "type": "m.room.member",
"state_key": "@alice:example.com", "state_key": "@alice:example.com",
"content": {"membership": "join"}, "content": {"membership": "join"},
"origin_server_ts": 1417731086795 "origin_server_ts": 1417731086795,
"event_id": "$66697273743031:example.com"
}
]
}, },
"$7365636s6r6432:example.com": { "timeline": {
"events": [
{
"sender": "@bob:example.com", "sender": "@bob:example.com",
"type": "m.room.member", "type": "m.room.member",
"state_key": "@bob:example.com", "state_key": "@bob:example.com",
"content": {"membership": "join"}, "content": {"membership": "join"},
"unsigned": { "prev_content": {"membership": "invite"},
"prev_content": {"membership": "invite"} "origin_server_ts": 1417731086795,
}, "event_id": "$7365636s6r6432:example.com"
"origin_server_ts": 1417731086795
}, },
"$74686972643033:example.com": { {
"sender": "@alice:example.com", "sender": "@alice:example.com",
"type": "m.room.message", "type": "m.room.message",
"unsigned": {"age": 124524, "transaction_id": "1234"}, "age": 124524,
"txn_id": "1234",
"content": { "content": {
"body": "I am a fish", "body": "I am a fish",
"msgtype": "m.text" "msgtype": "m.text"
}, },
"origin_server_ts": 1417731086797 "origin_server_ts": 1417731086797,
"event_id": "$74686972643033:example.com"
} }
},
"state": {
"events": [
"$66697273743031:example.com"
]
},
"timeline": {
"events": [
"$7365636s6r6432:example.com",
"$74686972643033:example.com"
], ],
"limited": true, "limited": true,
"prev_batch": "t34-23535_0_0" "prev_batch": "t34-23535_0_0"
@ -284,7 +255,7 @@ paths:
} }
} }
}, },
"invited": { "invite": {
"!696r7674:example.com": { "!696r7674:example.com": {
"invite_state": { "invite_state": {
"events": [ "events": [
@ -304,6 +275,6 @@ paths:
} }
} }
}, },
"archived": {} "leave": {}
} }
} }

5
specification/events.rst
Unescape Escape View File

@ -31,8 +31,9 @@ formatted for federation by:
``origin``, ``prev_state``. ``origin``, ``prev_state``.
* Adding an ``age`` to the ``unsigned`` object which gives the time in * Adding an ``age`` to the ``unsigned`` object which gives the time in
milliseconds that has elapsed since the event was sent. milliseconds that has elapsed since the event was sent.
* Adding a ``prev_content`` to the ``unsigned`` object if the event is * Adding ``prev_content`` and ``prev_sender`` to the ``unsigned`` object if the
a ``state event`` which gives previous content of that state key. event is a ``state event``, which give the previous content and previous
sender of that state key
* Adding a ``redacted_because`` to the ``unsigned`` object if the event was * Adding a ``redacted_because`` to the ``unsigned`` object if the event was
redacted which gives the event that redacted it. redacted which gives the event that redacted it.
* Adding a ``transaction_id`` to the ``unsigned`` object if the event was sent * Adding a ``transaction_id`` to the ``unsigned`` object if the event was sent

Write Preview
Loading…
Cancel
Save