Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-03-26 13:04:10 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Merge branch 'main' into rav/message_editing

Browse source
This commit is contained in:
Richard van der Hoff 2022-08-16 19:16:43 +01:00 committed by GitHub
parent 71f675926b 5572d33453
commit 3abe913f5d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
14 changed files with 131 additions and 44 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
assets/scss/custom.scss
View file

@ -260,6 +260,29 @@ footer {
border-left-width: 5px;
background: $warning-background;
}
// XXX: See the added-in-paragraph.html shortcode for more information on these styles.
&.added-in-paragraph {
// Remove the padding and margin to remove the box look
margin: 0 !important; // !important on both to override table-related rules
padding: 0 !important;
// Make pairs of "added-in" and content inline to each other. We do pairs so authors can
// describe two paragraphs with added-in prefixes within a single box, reducing DOM
// complexity. Each paragraph is expected to be prefixed with an added-in, however.
//
// XXX: We assume the added-in and text will be rendered as paragraph elements.
> p {
display: inline;
}
> p:nth-child(2n) { // "even" rule to target just the content paragraphs
// Force a paragraph break after the content (insert a couple <br /> tags)
&::after {
content: '\A\A';
white-space: pre;
}
}
}
}
/* Styles for sections that are rendered from data, such as HTTP APIs and event schemas */

1
changelogs/client_server/newsfragments/1197.feature Normal file
View file

@ -0,0 +1 @@
Add `Cross-Origin-Resource-Policy` (CORP) headers to media repository, as per [MSC3828](https://github.com/matrix-org/matrix-spec-proposals/pull/3828).

1
changelogs/client_server/newsfragments/1199.feature Normal file
View file

@ -0,0 +1 @@
Add `room_types` filter and `room_type` response to `/publicRooms`, as per [MSC3827](https://github.com/matrix-org/matrix-spec-proposals/pull/3827).

1
changelogs/client_server/newsfragments/1210.clarification Normal file
View file

@ -0,0 +1 @@
Clarify that the "device_id", "user_id" and "access_token" fields are required in the response body of `POST /_matrix/client/v3/login`.

1
changelogs/internal/newsfragments/1205.clarification Normal file
View file

@ -0,0 +1 @@
Fix rendering of shortcodes within the client-server API.

72
content/client-server-api/_index.md
View file

@ -2599,39 +2599,39 @@ operations and run in a resource constrained environment. Like embedded
applications, they are not intended to be fully-fledged communication
systems.
{{% cs-module name="instant_messaging" %}}
{{% cs-module name="rich_replies" %}}
{{% cs-module name="voip_events" %}}
{{% cs-module name="typing_notifications" %}}
{{% cs-module name="receipts" %}}
{{% cs-module name="read_markers" %}}
{{% cs-module name="presence" %}}
{{% cs-module name="content_repo" %}}
{{% cs-module name="send_to_device" %}}
{{% cs-module name="device_management" %}}
{{% cs-module name="end_to_end_encryption" %}}
{{% cs-module name="secrets" %}}
{{% cs-module name="history_visibility" %}}
{{% cs-module name="push" %}}
{{% cs-module name="third_party_invites" %}}
{{% cs-module name="search" %}}
{{% cs-module name="guest_access" %}}
{{% cs-module name="room_previews" %}}
{{% cs-module name="tags" %}}
{{% cs-module name="account_data" %}}
{{% cs-module name="admin" %}}
{{% cs-module name="event_context" %}}
{{% cs-module name="sso_login" %}}
{{% cs-module name="dm" %}}
{{% cs-module name="ignore_users" %}}
{{% cs-module name="stickers" %}}
{{% cs-module name="report_content" %}}
{{% cs-module name="third_party_networks" %}}
{{% cs-module name="openid" %}}
{{% cs-module name="server_acls" %}}
{{% cs-module name="mentions" %}}
{{% cs-module name="room_upgrades" %}}
{{% cs-module name="server_notices" %}}
{{% cs-module name="moderation_policies" %}}
{{% cs-module name="spaces" %}}
{{< cs-module name="event_replacements" >}}
{{< cs-module name="instant_messaging" >}}
{{< cs-module name="rich_replies" >}}
{{< cs-module name="voip_events" >}}
{{< cs-module name="typing_notifications" >}}
{{< cs-module name="receipts" >}}
{{< cs-module name="read_markers" >}}
{{< cs-module name="presence" >}}
{{< cs-module name="content_repo" >}}
{{< cs-module name="send_to_device" >}}
{{< cs-module name="device_management" >}}
{{< cs-module name="end_to_end_encryption" >}}
{{< cs-module name="secrets" >}}
{{< cs-module name="history_visibility" >}}
{{< cs-module name="push" >}}
{{< cs-module name="third_party_invites" >}}
{{< cs-module name="search" >}}
{{< cs-module name="guest_access" >}}
{{< cs-module name="room_previews" >}}
{{< cs-module name="tags" >}}
{{< cs-module name="account_data" >}}
{{< cs-module name="admin" >}}
{{< cs-module name="event_context" >}}
{{< cs-module name="sso_login" >}}
{{< cs-module name="dm" >}}
{{< cs-module name="ignore_users" >}}
{{< cs-module name="stickers" >}}
{{< cs-module name="report_content" >}}
{{< cs-module name="third_party_networks" >}}
{{< cs-module name="openid" >}}
{{< cs-module name="server_acls" >}}
{{< cs-module name="mentions" >}}
{{< cs-module name="room_upgrades" >}}
{{< cs-module name="server_notices" >}}
{{< cs-module name="moderation_policies" >}}
{{< cs-module name="spaces" >}}
{{< cs-module name="event_replacements" >}}

7
content/client-server-api/modules/content_repo.md
View file

@ -19,6 +19,13 @@ When serving content, the server SHOULD provide a
`Content-Security-Policy` header. The recommended policy is
`sandbox; default-src 'none'; script-src 'none'; plugin-types application/pdf; style-src 'unsafe-inline'; object-src 'self';`.
{{% boxes/added-in-paragraph %}}
{{< added-in v="1.4" >}} The server SHOULD additionally provide
`Cross-Origin-Resource-Policy: cross-origin` when serving content to allow
(web) clients to access restricted APIs such as `SharedArrayBuffer` when
interacting with the media repository.
{{% /boxes/added-in-paragraph %}}
#### Matrix Content (MXC) URIs
Content locations are represented as Matrix Content (MXC) URIs. They

5
data/api/client-server/definitions/public_rooms_chunk.yaml
View file

@ -57,6 +57,11 @@ properties:
The room's join rule. When not present, the room is assumed to
be `public`.
example: "public"
room_type:
type: string
x-addedInMatrixVersion: "1.4"
description: |-
The `type` of room (from [`m.room.create`](/client-server-api/#mroomcreate)), if any.
required:
- room_id
- num_joined_members

3
data/api/client-server/definitions/public_rooms_response.yaml
View file

@ -62,7 +62,8 @@ example: {
"room_id": "!ol19s:bleecker.street",
"topic": "Tasty tasty cheese",
"world_readable": true,
"join_rule": "public"
"join_rule": "public",
"room_type": "m.space"
}
],
"next_batch": "p190q",

17
data/api/client-server/list_public_rooms.yaml
View file

@ -198,8 +198,18 @@ paths:
generic_search_term:
type: string
description: |-
A string to search for in the room metadata, e.g. name,
topic, canonical alias etc. (Optional).
An optional string to search for in the room metadata, e.g. name,
topic, canonical alias, etc.
room_types:
type: array
x-addedInMatrixVersion: "1.4"
items:
type: string
description: |-
An optional list of [room types](/client-server-api/#types) to search
for. To include rooms without a room type, specify `null` within this
list. When not specified, all applicable rooms (regardless of type)
are returned.
include_all_networks:
type: boolean
description: |-
@ -215,7 +225,8 @@ paths:
example: {
"limit": 10,
"filter": {
"generic_search_term": "foo"
"generic_search_term": "foo",
"room_types": [null, "m.space"]
},
"include_all_networks": false,
"third_party_instance_id": "irc"

1
data/api/client-server/login.yaml
View file

@ -210,6 +210,7 @@ paths:
form as the one returned from .well-known autodiscovery.
allOf:
- "$ref": "definitions/wellknown/full.yaml"
required: ["access_token", "device_id", "user_id"]
400:
description: |-
Part of the request was invalid. For example, the login type may not be recognised.

1
data/api/client-server/space_hierarchy.yaml
View file

@ -129,6 +129,7 @@ paths:
- type: object
title: ChildRoomsChunk
properties:
# Override x-addedInMatrixVersion for room_type (this endpoint had it first)
room_type:
type: string
description: |-

20
data/api/server-server/public_rooms.yaml
View file

@ -110,8 +110,18 @@ paths:
generic_search_term:
type: string
description: |-
A string to search for in the room metadata, e.g. name,
topic, canonical alias etc. (Optional).
An optional string to search for in the room metadata, e.g. name,
topic, canonical alias, etc.
room_types:
type: array
x-addedInMatrixVersion: "1.4"
items:
type: string
description: |-
An optional list of [room types](/client-server-api/#types) to search
for. To include rooms without a room type, specify `null` within this
list. When not specified, all applicable rooms (regardless of type)
are returned.
include_all_networks:
type: boolean
description: |-
@ -127,7 +137,8 @@ paths:
example: {
"limit": 10,
"filter": {
"generic_search_term": "foo"
"generic_search_term": "foo",
"room_types": [null, "m.space"]
},
"include_all_networks": false,
"third_party_instance_id": "irc"
@ -185,7 +196,8 @@ paths:
"room_id": "!ol19s:bleecker.street",
"topic": "Tasty tasty cheese",
"world_readable": true,
"join_rule": "public"
"join_rule": "public",
"room_type": "m.space"
}
],
"next_batch": "p190q",

22
layouts/shortcodes/boxes/added-in-paragraph.html Normal file
View file

@ -0,0 +1,22 @@
{{/*
"Temporary" shortcode for rendering paragraphs which want/need inline added-in tags. It is
assumed that your content is described as follows:
{{% boxes/added-in-paragraph %}}
{{< added-in v="1.4" >}} Your text here
{{< added-in v="1.4" >}} Your other text here
{{% /boxes/added-in-paragraph %}}
The assumption is that at a later date this added-in-paragraph shortcode can be removed, making
the angle bracket-defined added-in shortcodes *just work*.
It is important that each new "content" paragraph (the bit after added-in) is preceded with
and added-in, otherwise you might find your text being weirdly merged.
This exists while the added-in shortcode cannot be inline in the client-server spec.
See https://github.com/matrix-org/matrix-spec/issues/1204
*/}}
{{ partial "alert" (dict "type" "added-in-paragraph" "content" .Inner) }}