Add x-changedInMatrixVersion for from param

This commit is contained in:
Germain Souquet 2022-01-17 09:20:57 +00:00 committed by Jonas Platte
parent 6fb26697e8
commit 523ad2ceaf
No known key found for this signature in database
GPG key ID: BBA95679259D342F

View file

@ -11,7 +11,7 @@
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and # See the License for the specific language governing permissions and
# limitations under the License. # limitations under the License.
swagger: '2.0' swagger: "2.0"
info: info:
title: "Matrix Client-Server Rooms API" title: "Matrix Client-Server Rooms API"
version: "1.0.0" version: "1.0.0"
@ -49,6 +49,7 @@ paths:
- in: query - in: query
type: string type: string
name: from name: from
x-changedInMatrixVersion: "1.2"
description: |- description: |-
The token to start returning events from. This token can be obtained The token to start returning events from. This token can be obtained
from a `prev_batch` or `next_batch` token returned by the `/sync` endpoint, from a `prev_batch` or `next_batch` token returned by the `/sync` endpoint,
@ -145,23 +146,25 @@ paths:
$ref: "definitions/client_event.yaml" $ref: "definitions/client_event.yaml"
required: [start, chunk] required: [start, chunk]
examples: examples:
application/json: { application/json:
{
"start": "t47429-4392820_219380_26003_2265", "start": "t47429-4392820_219380_26003_2265",
"end": "t47409-4357353_219380_26003_2265", "end": "t47409-4357353_219380_26003_2265",
"chunk": [ "chunk":
{ [
"room_id": "!636q39766251:example.com", {
"$ref": "../../event-schemas/examples/m.room.message$m.text.yaml" "room_id": "!636q39766251:example.com",
}, "$ref": "../../event-schemas/examples/m.room.message$m.text.yaml",
{ },
"room_id": "!636q39766251:example.com", {
"$ref": "../../event-schemas/examples/m.room.name.yaml" "room_id": "!636q39766251:example.com",
}, "$ref": "../../event-schemas/examples/m.room.name.yaml",
{ },
"room_id": "!636q39766251:example.com", {
"$ref": "../../event-schemas/examples/m.room.message$m.video.yaml" "room_id": "!636q39766251:example.com",
} "$ref": "../../event-schemas/examples/m.room.message$m.video.yaml",
] },
],
} }
403: 403:
description: > description: >