mirror of
https://github.com/matrix-org/matrix-spec
synced 2025-12-24 18:08:37 +01:00
820704a16a
According the the openapi spec, examples for responses and schemas should be raw objects rather than being json strings. (It's unclear what non-json examples should look like...). The swagger UI used to support json strings, but no longer does. In short, let's turn the json strings into their raw formats.
89 lines
2.8 KiB
YAML
89 lines
2.8 KiB
YAML
# Copyright 2016 OpenMarket 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.
|
|
swagger: '2.0'
|
|
info:
|
|
title: "Matrix Client-Server message event send API"
|
|
version: "1.0.0"
|
|
host: localhost:8008
|
|
schemes:
|
|
- https
|
|
- http
|
|
basePath: /_matrix/client/%CLIENT_MAJOR_VERSION%
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
securityDefinitions:
|
|
$ref: definitions/security.yaml
|
|
paths:
|
|
"/rooms/{roomId}/send/{eventType}/{txnId}":
|
|
put:
|
|
summary: Send a message event to the given room.
|
|
description: |-
|
|
This endpoint is used to send a message event to a room. Message events
|
|
allow access to historical events and pagination, making them suited
|
|
for "once-off" activity in a room.
|
|
|
|
The body of the request should be the content object of the event; the
|
|
fields in this object will vary depending on the type of event. See
|
|
`Room Events`_ for the m. event specification.
|
|
security:
|
|
- accessToken: []
|
|
parameters:
|
|
- in: path
|
|
type: string
|
|
name: roomId
|
|
description: The room to send the event to.
|
|
required: true
|
|
x-example: "!636q39766251:example.com"
|
|
- in: path
|
|
type: string
|
|
name: eventType
|
|
description: The type of event to send.
|
|
required: true
|
|
x-example: "m.room.message"
|
|
- in: path
|
|
name: txnId
|
|
type: string
|
|
description: |-
|
|
The transaction ID for this event. Clients should generate an
|
|
ID unique across requests with the same access token; it will be
|
|
used by the server to ensure idempotency of requests.
|
|
required: true
|
|
x-example: "35"
|
|
- in: body
|
|
name: body
|
|
schema:
|
|
type: object
|
|
example: {
|
|
"msgtype": "m.text",
|
|
"body": "hello"
|
|
}
|
|
responses:
|
|
200:
|
|
description: "An ID for the sent event."
|
|
examples:
|
|
application/json: {
|
|
"event_id": "YUwRidLecu"
|
|
}
|
|
schema:
|
|
type: object
|
|
properties:
|
|
event_id:
|
|
type: string
|
|
description: |-
|
|
A unique identifier for the event.
|
|
tags:
|
|
- Room participation
|