As a side effect, I got rid of all of the horrible symlinks and just put in all of the proper relative paths. Because the horrible symlinks were horrible.
131 lines
4.3 KiB
YAML
131 lines
4.3 KiB
YAML
swagger: '2.0'
|
|
info:
|
|
title: "Matrix Client-Server v1 Rooms API"
|
|
version: "1.0.0"
|
|
host: localhost:8008
|
|
schemes:
|
|
- https
|
|
- http
|
|
basePath: /_matrix/client/api/v1
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
securityDefinitions:
|
|
accessToken:
|
|
type: apiKey
|
|
description: The user_id or application service access_token
|
|
name: access_token
|
|
in: query
|
|
paths:
|
|
"/rooms/{roomId}/messages":
|
|
get:
|
|
summary: Get a list of events for this room
|
|
description: |-
|
|
This API returns a list of message and state events for a room. It uses
|
|
pagination query parameters to paginate history in the room.
|
|
security:
|
|
- accessToken: []
|
|
parameters:
|
|
- in: path
|
|
type: string
|
|
name: roomId
|
|
description: The room to get events from.
|
|
required: true
|
|
x-example: "!636q39766251:example.com"
|
|
- in: query
|
|
type: string
|
|
name: from
|
|
description: |-
|
|
The token to start returning events from. This token can be obtained
|
|
from the initial sync API.
|
|
required: true
|
|
x-example: "s345_678_333"
|
|
- in: query
|
|
type: string
|
|
enum: ["b", "f"]
|
|
name: dir
|
|
description: |-
|
|
The direction to return events from.
|
|
required: true
|
|
x-example: "b"
|
|
- in: query
|
|
type: integer
|
|
name: limit
|
|
description: |-
|
|
The maximum number of events to return. Default: 10.
|
|
x-example: "3"
|
|
responses:
|
|
200:
|
|
description: A list of messages with a new token to request more.
|
|
schema:
|
|
type: object
|
|
description: A list of messages with a new token to request more.
|
|
properties:
|
|
start:
|
|
type: string
|
|
description: |-
|
|
The token to start paginating from. If ``dir=b`` this will be
|
|
the token supplied in ``from``.
|
|
end:
|
|
type: string
|
|
description: |-
|
|
The token the pagination ends at. If ``dir=b`` this token should
|
|
be used again to request even earlier events.
|
|
chunk:
|
|
type: array
|
|
description: |-
|
|
A list of room events.
|
|
items:
|
|
type: object
|
|
title: RoomEvent
|
|
examples:
|
|
application/json: |-
|
|
{
|
|
"start": "t47429-4392820_219380_26003_2265",
|
|
"end": "t47409-4357353_219380_26003_2265",
|
|
"chunk": [
|
|
{
|
|
"origin_server_ts": 1444812213737,
|
|
"user_id": "@alice:example.com",
|
|
"event_id": "$1444812213350496Caaaa:example.com",
|
|
"content": {
|
|
"body": "hello world",
|
|
"msgtype":"m.text"
|
|
},
|
|
"room_id":"!Xq3620DUiqCaoxq:example.com",
|
|
"type":"m.room.message",
|
|
"age": 1042
|
|
},
|
|
{
|
|
"origin_server_ts": 1444812194656 ,
|
|
"user_id": "@bob:example.com",
|
|
"event_id": "$1444812213350496Cbbbb:example.com",
|
|
"content": {
|
|
"body": "the world is big",
|
|
"msgtype":"m.text"
|
|
},
|
|
"room_id":"!Xq3620DUiqCaoxq:example.com",
|
|
"type":"m.room.message",
|
|
"age": 20123
|
|
},
|
|
{
|
|
"origin_server_ts": 1444812163990,
|
|
"user_id": "@bob:example.com",
|
|
"event_id": "$1444812213350496Ccccc:example.com",
|
|
"content": {
|
|
"name": "New room name"
|
|
},
|
|
"prev_content": {
|
|
"name": "Old room name"
|
|
},
|
|
"state_key": "",
|
|
"room_id":"!Xq3620DUiqCaoxq:example.com",
|
|
"type":"m.room.name",
|
|
"age": 50789
|
|
}
|
|
]
|
|
}
|
|
403:
|
|
description: >
|
|
You aren't a member of the room.
|