mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-03-28 22:14:10 +01:00
Receipts: Add thread_id to the /receipt endpoint
It seems to have been omitted in #1255 Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
This commit is contained in:
parent
434f1b0672
commit
174fcf2821
|
|
@ -74,8 +74,18 @@ paths:
|
||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
|
properties:
|
||||||
|
thread_id:
|
||||||
|
type: string
|
||||||
|
x-addedInMatrixVersion: "1.4"
|
||||||
|
description: |-
|
||||||
|
The root thread event's ID (or `main`) for which
|
||||||
|
thread this receipt is intended to be under. If
|
||||||
|
not specified, the read receipt is *unthreaded*
|
||||||
|
(default).
|
||||||
example: {
|
example: {
|
||||||
}
|
"thread_id": "main"
|
||||||
|
}
|
||||||
responses:
|
responses:
|
||||||
200:
|
200:
|
||||||
description: The receipt was sent.
|
description: The receipt was sent.
|
||||||
|
|
@ -88,5 +98,17 @@ paths:
|
||||||
description: This request was rate-limited.
|
description: This request was rate-limited.
|
||||||
schema:
|
schema:
|
||||||
"$ref": "definitions/errors/rate_limited.yaml"
|
"$ref": "definitions/errors/rate_limited.yaml"
|
||||||
|
400:
|
||||||
|
description: |-
|
||||||
|
The `thread_id is not a string, or is empty, or it is provided for
|
||||||
|
a receipt of type `m.fully_read`, or the `event_id` is not related
|
||||||
|
to the `thread_id`.
|
||||||
|
schema:
|
||||||
|
$ref: "definitions/errors/error.yaml"
|
||||||
|
examples:
|
||||||
|
application/json: {
|
||||||
|
"errcode": "M_INVALID_PARAM",
|
||||||
|
"error": "thread_id field must be a non-empty string"
|
||||||
|
}
|
||||||
tags:
|
tags:
|
||||||
- Room participation
|
- Room participation
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue