You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
68 lines
1.9 KiB
YAML
68 lines
1.9 KiB
YAML
9 years ago
|
swagger: '2.0'
|
||
|
|
info:
|
||
|
|
title: "Matrix Client-Server v2 Receipts API"
|
||
|
|
version: "1.0.0"
|
||
|
|
host: localhost:8008
|
||
|
|
schemes:
|
||
|
|
- https
|
||
|
|
- http
|
||
|
|
basePath: /_matrix/client/v2_alpha
|
||
|
|
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}/receipt/{receiptType}/{eventId}":
|
||
|
|
post:
|
||
|
|
summary: Send a receipt for the given event ID.
|
||
|
|
description: |-
|
||
|
|
This API updates the marker for the given receipt type to the event ID
|
||
|
|
specified.
|
||
|
|
security:
|
||
|
|
- accessToken: []
|
||
|
|
parameters:
|
||
|
|
- in: path
|
||
|
|
type: string
|
||
|
|
name: roomId
|
||
|
|
description: The room in which to send the event.
|
||
|
|
required: true
|
||
|
|
x-example: "!wefuh21ffskfuh345:example.com"
|
||
|
|
- in: path
|
||
|
|
type: string
|
||
|
|
name: receiptType
|
||
|
|
description: The type of receipt to send.
|
||
|
|
required: true
|
||
|
|
x-example: "m.read"
|
||
|
|
enum: ["m.read"]
|
||
|
|
- in: path
|
||
|
|
type: string
|
||
|
|
name: eventId
|
||
|
|
description: The event ID to acknowledge up to.
|
||
|
|
required: true
|
||
|
|
x-example: "$1924376522eioj:example.com"
|
||
|
|
- in: body
|
||
|
|
description: |-
|
||
|
|
Extra receipt information to attach to ``content`` if any. The
|
||
|
|
server will automatically set the ``ts`` field.
|
||
|
|
schema:
|
||
|
|
type: object
|
||
|
|
example: |-
|
||
|
|
{}
|
||
|
|
responses:
|
||
|
|
200:
|
||
|
|
description: The receipt was sent.
|
||
|
|
examples:
|
||
|
|
application/json: |-
|
||
|
|
{}
|
||
|
|
schema:
|
||
|
|
type: object # empty json object
|
||
|
|
429:
|
||
|
|
description: This request was rate-limited.
|
||
|
|
schema:
|
||
|
|
"$ref": "definitions/error.yaml"
|