36b02edfc2
Fixes #3305 Fixes #3380 The idea here is to better distinguish between a 'raw' event (as we send over the wire), and the 'serialised' format, as sent in responses to the C-S api and in `PUT /_matrix/app/v1/transactions/{txnId}`. It's made more complicated by the fact that there are _two_ serialisation formats, one used by `/sync` and `/notifications`, and one by everything else (the difference being whether `room_id` is included). In an ideal world, we wouldn't repeat `SerialisedEvent` every time it's used, and instead just link to the first reference, but that's a job for another day. Another job for another day is to get rid of things like `sync_state_event.yaml` (which is now used only in one place, so should be inlined.)
36 lines
1.2 KiB
YAML
36 lines
1.2 KiB
YAML
# Copyright 2016 OpenMarket Ltd
|
|
# Copyright 2018 New Vector Ltd
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
properties:
|
|
limited:
|
|
description: True if the number of events returned was limited by the `limit`
|
|
on the filter.
|
|
type: boolean
|
|
prev_batch:
|
|
description: A token that can be supplied to the `from` parameter of the
|
|
[`/rooms/<room_id>/messages`](#get_matrixclientv3roomsroomidmessages)
|
|
endpoint in order to retrieve earlier events.
|
|
|
|
If no earlier events are available, this property may be omitted from
|
|
the response.
|
|
type: string
|
|
events:
|
|
description: List of events.
|
|
type: array
|
|
items:
|
|
$ref: "client_event_without_room_id.yaml"
|
|
type: object
|
|
title: TimelineBatch
|
|
required:
|
|
- events
|