mirror of
https://github.com/matrix-org/matrix-spec
synced 2025-12-26 02:48:37 +01:00
c4db688af8
* Commit to show changes to rich replies section * Move rich replies to a module * Add remainder of MSC2674 * Pivot away from MSC3440: Threads * Add changelog entries so far * Make a note for why we have aggregations/relations if nothing uses it * Outright remove threads references Apparently this breaks the table of contents * Define MSC2675 * Define MSC3666 * Add note for rich replies? * Update content/client-server-api/_index.md Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com> * Clarify how ignoring works for aggregations. * Try to clarify redactions a bit * Clarify using parent/child language * Add missing bits of MSC2675 * Add changelog for aggregations * Appease the linters * Update data/api/client-server/relations.yaml Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * Try to clarify the return of /relations * Fix required attribute * Fix wording round 1 * Try to fix pagination * Copy/paste the endpoint to make Open API happy * Fix code block examples for rich replies * Apply suggestions from code review Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * Apply suggestions on all 3 endpoints * Fix description of relationships API * Fix warning about server-side aggregation/bundling Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com> Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
44 lines
1.7 KiB
YAML
44 lines
1.7 KiB
YAML
# Copyright 2022 The Matrix.org Foundation C.I.C.
|
|
#
|
|
# 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.
|
|
|
|
type: object
|
|
title: m.relates_to
|
|
description: |-
|
|
Describes the relationship of an event to its parent. This is contained
|
|
within the event's `content` alongside other fields for the relevant event type.
|
|
example: {
|
|
# We deliberately "break" the example by including the top-level field so it renders
|
|
# sensibly for readers of the spec.
|
|
"m.relates_to": {
|
|
"rel_type": "org.example.relationship",
|
|
"event_id": "$an_event"
|
|
}
|
|
}
|
|
properties:
|
|
rel_type:
|
|
type: string
|
|
description: |-
|
|
The namespaced relationship type. Values must use the
|
|
[Common Namespaced Identifier Grammar](/appendices/#common-namespaced-identifier-grammar).
|
|
|
|
The relationship type determines how clients should perceive the event, and in what
|
|
context. Some relationship types are processed server-side for "bundling", though not
|
|
all relationships require such behaviour. For example, an `m.thread` relationship type
|
|
might denote that the event is part of a "thread" of messages and should be rendered as
|
|
such.
|
|
event_id:
|
|
type: string
|
|
description: The event ID of the event that this event relates to.
|
|
required: ['rel_type', 'event_id']
|