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

Split the room_map into separate sections based on whether they are

Browse Source 
"joined/invited/archived".

Rename the room_map to rooms and remove the grouping indirection. When we
want groups then we can add them under a separate key, either at the
top-level or as part of the events themselves.
markjh/v2_sync_api
Mark Haines 9 years ago
parent 0e5b00feaa
commit 0ce533d153
1 changed files with 153 additions and 142 deletions
Show Stats Download Patch File Download Diff File

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

@ -74,38 +74,9 @@ paths:
rooms: rooms:
type: object type: object
description: |- description: |-
The updates to rooms, grouped according to the filter. By Updates to rooms.
default there is a single ``default`` group. properties:
additionalProperties:
joined: joined:
type: array
description: |-
A list of room ids that the user is a member of that
have updates.
items:
type: string.
invited:
type: array
description: |-
A list of room ids that the user has been invited to.
The entries in the room_map will have an
``invite_state`` key. But will lack the ``ephemeral``
key, the ``timeline`` key and the ``state`` key.
items:
type: string.
archived:
type: array
description: |-
A list of room ids that the user has left or been
banned from. The entries in the room_map will have a
``state`` key and a ``timeline`` key. But will lack the
``ephemeral`` key.
items:
type: string.
room_map:
description: |-
Map from room id to the updates for that room. The room ids
are referenced from the ``rooms`` key.
type: object type: object
additionalProperties: additionalProperties:
type: object type: object
@ -113,9 +84,9 @@ paths:
event_map: event_map:
type: object type: object
description: |- description: |-
A map from event ID to events for this room. The events A map from event ID to events for this room. The
are referenced from the ``timeline`` and ``state`` keys events are referenced from the ``timeline`` and
for this room. ``state`` keys for this room.
additionalProperties: additionalProperties:
description: An event object. description: An event object.
type: object type: object
@ -126,30 +97,69 @@ paths:
- $ref: "definitions/room_event_batch.json" - $ref: "definitions/room_event_batch.json"
timeline: timeline:
description: |- description: |-
The timeline of messages and state changes in the room. The timeline of messages and state changes in the
room.
allOf: allOf:
- $ref: "definitions/timeline_batch.json" - $ref: "definitions/timeline_batch.json"
ephemeral: ephemeral:
description: |- description: |-
The ephemeral events in the room that aren't recorded The ephemeral events in the room that aren't
in the timeline or state of the room. E.g. typing. recorded in the timeline or state of the room.
e.g. typing.
allOf: allOf:
- $ref: "definitions/event_batch.json" - $ref: "definitions/event_batch.json"
invited:
type: object
description: |-
The rooms that the user has been invited to.
additionalProperties:
type: object
properties:
invite_state: invite_state:
description: |- description: |-
The state of a room that the user has been invited to. The state of a room that the user has been invited
These state events may only have the `sender``, to. These state events may only have the `sender``,
``type``, ``state_key`` and ``content`` keys present. ``type``, ``state_key`` and ``content`` keys
These events do not replace any state that the client present. These events do not replace any state that
already has for the room, for example if the client has the client already has for the room, for example if
archived the room. Instead the client should keep two the client has archived the room. Instead the
separate copies of the state: the one from the client should keep two separate copies of the
``invite_state`` and one from the archived ``state``. state: the one from the ``invite_state`` and one
If the client joins the room then the current state from the archived ``state``. If the client joins
will be given as a delta against the archived ``state`` the room then the current state will be given as a
not the ``invite_state``. delta against the archived ``state`` not the
``invite_state``.
allOf: allOf:
- $ref: "definitions/event_batch.json" - $ref: "definitions/event_batch.json"
archived:
type: object
description: |-
The rooms that the user has left or been banned from. The
entries in the room_map will lack an ``ephemeral`` key.
additionalProperties:
type: object
properties:
event_map:
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:
description: An event object.
type: object
state:
description: |-
The state updates for the room up to the point when
the user left.
allOf:
- $ref: "definitions/room_event_batch.json"
timeline:
description: |-
The timeline of messages and state changes in the
room up to the point when the user left.
allOf:
- $ref: "definitions/timeline_batch.json"
presence: presence:
description: |- description: |-
The updates to the presence status of other users. The updates to the presence status of other users.
@ -169,13 +179,7 @@ paths:
] ]
}, },
"rooms": { "rooms": {
"default": { "joined": {
"invited": ["!696r7674:example.com"],
"archived": [],
"joined": ["!726s6s6q:example.com"]
}
},
"room_map": {
"!726s6s6q:example.com": { "!726s6s6q:example.com": {
"event_map": { "event_map": {
"$66697273743031:example.com": { "$66697273743031:example.com": {
@ -196,7 +200,10 @@ paths:
"sender": "@alice:example.com", "sender": "@alice:example.com",
"type": "m.room.message", "type": "m.room.message",
"unsigned": {"age": "124524", "txn_id": "1234"}, "unsigned": {"age": "124524", "txn_id": "1234"},
"content": {"body": "I am a fish", "msgtype": "m.text"}, "content": {
"body": "I am a fish",
"msgtype": "m.text"
},
"origin_server_ts": 1417731086797 "origin_server_ts": 1417731086797
} }
}, },
@ -223,7 +230,9 @@ paths:
} }
] ]
} }
}
}, },
"invited": {
"!696r7674:example.com": { "!696r7674:example.com": {
"invite_state": { "invite_state": {
"events": [ "events": [
@ -242,5 +251,7 @@ paths:
] ]
} }
} }
},
"archived": {}
} }
} }

Write Preview
Loading…
Cancel
Save