wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Matrix 1.10

Browse source
This commit is contained in:
Travis Ralston 2024-03-22 09:47:03 -06:00
parent 7c19d24e3a
commit f7452e2bad
41 changed files with 106 additions and 43 deletions
Download patch file Download diff file Expand all files Collapse all files

1
changelogs/application_service/newsfragments/1744.clarification
View file

@ -1 +0,0 @@
Clarify that the `/login` and `/register` endpoints should fail when using the `m.login.application_service` login type without a valid `as_token`.

1
changelogs/client_server/newsfragments/1629.clarification
View file

@ -1 +0,0 @@
The [strike](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/strike) element is deprecated in the HTML spec. Clients should prefer [s](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/s) instead.

1
changelogs/client_server/newsfragments/1685.clarification
View file

@ -1 +0,0 @@
Clarify that read receipts should be batched by thread as well as by room.

1
changelogs/client_server/newsfragments/1687.clarification
View file

@ -1 +0,0 @@
Clarify that threads can be created based on replies.

1
changelogs/client_server/newsfragments/1690.clarification
View file

@ -1 +0,0 @@
Clarify in the reply fallbacks example that the prefix sequence should be repeated for each line.

1
changelogs/client_server/newsfragments/1695.clarification
View file

@ -1 +0,0 @@
Clarify the format of account data objects for secret storage.

1
changelogs/client_server/newsfragments/1712.clarification
View file

@ -1 +0,0 @@
Clarify that the key backup MAC is implemented incorrectly and does not pass the ciphertext through HMAC-SHA-256.

1
changelogs/client_server/newsfragments/1715.clarification
View file

@ -1 +0,0 @@
Clarify one-time key and fallback key types in examples.

1
changelogs/client_server/newsfragments/1719.clarification
View file

@ -1 +0,0 @@
Clarify that the HKDF calculation for SAS uses base64-encoded keys rather than the raw key bytes.

1
changelogs/client_server/newsfragments/1720.clarification
View file

@ -1 +0,0 @@
Clarify how to perform the ECDH exchange in step 12 of the SAS process.

1
changelogs/client_server/newsfragments/1728.feature
View file

@ -1 +0,0 @@
Allow `/versions` to optionally accept authentication, as per [MSC4026](https://github.com/matrix-org/matrix-spec-proposals/pull/4026).

1
changelogs/client_server/newsfragments/1730.feature
View file

@ -1 +0,0 @@
Add local erasure requests, as per [MSC4025](https://github.com/matrix-org/matrix-spec-proposals/pull/4025).

1
changelogs/client_server/newsfragments/1731.feature
View file

@ -1 +0,0 @@
Use the `body` field as optional media caption, as per [MSC2530](https://github.com/matrix-org/matrix-spec-proposals/pull/2530).

1
changelogs/client_server/newsfragments/1732.clarification
View file

@ -1 +0,0 @@
Document the deprecation policy of HTML tags, as per [MSC4077](https://github.com/matrix-org/matrix-spec-proposals/pull/4077).

1
changelogs/client_server/newsfragments/1733.feature
View file

@ -1 +0,0 @@
Add server support discovery endpoint, as per [MSC1929](https://github.com/matrix-org/matrix-spec-proposals/pull/1929).

1
changelogs/client_server/newsfragments/1734.clarification
View file

@ -1 +0,0 @@
Clarify the format of account data objects for secret storage.

1
changelogs/client_server/newsfragments/1735.feature
View file

@ -1 +0,0 @@
Add support for multi-stream VoIP, as per [MSC3077](https://github.com/matrix-org/matrix-spec-proposals/pull/3077).

1
changelogs/client_server/newsfragments/1737.feature
View file

@ -1 +0,0 @@
Specify that the `Retry-After` header may be used to rate-limit a client, as per [MSC4041](https://github.com/matrix-org/matrix-spec-proposals/pull/4041).

1
changelogs/client_server/newsfragments/1739.clarification
View file

@ -1 +0,0 @@
The [font](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/font) element is deprecated in the HTML spec. Clients should prefer [span](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/span) with the `data-mx-bg-color` and `data-mx-color` attributes instead.

1
changelogs/client_server/newsfragments/1740.clarification
View file

@ -1 +0,0 @@
Disambiguate uses of `PublicRoomsChunk` in the `GET /hierarchy` endpoint.

1
changelogs/client_server/newsfragments/1742.clarification
View file

@ -1 +0,0 @@
Clarify that `sdpMid` and `sdpMLineIndex` are not required in `m.call.candidates`.

1
changelogs/client_server/newsfragments/1746.feature
View file

@ -1 +0,0 @@
Add support for recursion on the `GET /relations` endpoints, as per [MSC3981](https://github.com/matrix-org/matrix-spec-proposals/pull/3981).

1
changelogs/client_server/newsfragments/1748.clarification
View file

@ -1 +0,0 @@
Fix various typos throughout the specification.

1
changelogs/client_server/newsfragments/1756.clarification
View file

@ -1 +0,0 @@
Clearly indicate that each `Content-Type` may have distinct behaviour on non-JSON requests/responses.

1
changelogs/client_server/newsfragments/1763.clarification
View file

@ -1 +0,0 @@
Clarify that the `m.push_rules` account data type cannot be set using the `/account_data` API, as per [MSC4010](https://github.com/matrix-org/matrix-spec-proposals/pull/4010).

1
changelogs/internal/newsfragments/1680.clarification
View file

@ -1 +0,0 @@
Update the spec release process.

1
changelogs/internal/newsfragments/1697.clarification
View file

@ -1 +0,0 @@
Minor clarifications to the contributing guide.

1
changelogs/internal/newsfragments/1699.clarification
View file

@ -1 +0,0 @@
Update Docsy to v0.8.0.

1
changelogs/internal/newsfragments/1713.clarification
View file

@ -1 +0,0 @@
Fix npm release script for `@matrix-org/spec`.

1
changelogs/internal/newsfragments/1718.clarification
View file

@ -1 +0,0 @@
Add some clarifications around implementation requirements for MSCs.

1
changelogs/internal/newsfragments/1724.clarification
View file

@ -1 +0,0 @@
Update HTML templates to include links to object schema definitions.

1
changelogs/internal/newsfragments/1745.clarification
View file

@ -1 +0,0 @@
Factor out all the common parameters of the various `/relations` apis.

1
changelogs/internal/newsfragments/1751.clarification
View file

@ -1 +0,0 @@
Add support for `$ref` URIs containing fragments in OpenAPI definitions and JSON schemas.

1
changelogs/internal/newsfragments/1754.clarification
View file

@ -1 +0,0 @@
Add support for `$ref` URIs containing fragments in OpenAPI definitions and JSON schemas.

1
changelogs/internal/newsfragments/1762.clarification
View file

@ -1 +0,0 @@
Update Docsy to v0.8.0.

1
changelogs/room_versions/newsfragments/1717.clarification
View file

@ -1 +0,0 @@
For room versions 7 through 11: Clarify that `invite->knock` is not a legal transition.

1
changelogs/server_server/newsfragments/1721.clarification
View file

@ -1 +0,0 @@
Clarify Server-Server API request signing example by using the `POST` HTTP method, as `GET` requests don't have request bodies.

1
changelogs/server_server/newsfragments/1740.clarification
View file

@ -1 +0,0 @@
Disambiguate uses of `PublicRoomsChunk` in the `GET /hierarchy` endpoint.

1
changelogs/server_server/newsfragments/1741.clarification
View file

@ -1 +0,0 @@
Clarify that the `children_state`, `room_type` and `allowed_room_ids` properties in the items of the `children` array of the response of the `GET /hierarchy` endpoint are not required.

8
config.toml
View file

@ -59,14 +59,14 @@ privacy_policy = "https://matrix.org/legal/privacy-notice"
[params.version]
# must be one of "unstable", "current", "historical"
# this is used to decide whether to show a banner pointing to the current release
status = "unstable"
status = "stable"
# A URL pointing to the latest, stable release of the spec. To be shown in the unstable version warning banner.
current_version_url = "https://spec.matrix.org/latest"
# The following is used when status = "stable", and is displayed in various UI elements on a released version
# of the spec. CI will set these values here automatically when a release git tag (i.e `v1.5`) is created.
# major = "1"
# minor = "9"
# release_date = "November 29, 2023"
major = "1"
minor = "10"
release_date = "March 22, 2024"
# User interface configuration
[params.ui]

102
content/changelog/v1.10.md Normal file
View file

@ -0,0 +1,102 @@
---
date: 2024-03-22T09:59:45-06:00
---
<!--
This is a header file for the generated changelog.
Variables:
v1.10 = Replaced by the version number (eg: v1.2)
March 22, 2024 = Replaced by the date (eg: April 01, 2021)
-->
## v1.10
<table class="release-info">
<tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-spec/tree/v1.10">https://github.com/matrix-org/matrix-spec/tree/v1.10</a></td>
<tr><th>Release date</th><td>March 22, 2024</td>
</table>
<!-- Intentionally blank line to ensure headers work in the concatenated changelog -->
### Client-Server API
**Backwards Compatible Changes**
- Allow `/versions` to optionally accept authentication, as per [MSC4026](https://github.com/matrix-org/matrix-spec-proposals/pull/4026). ([#1728](https://github.com/matrix-org/matrix-spec/issues/1728))
- Add local erasure requests, as per [MSC4025](https://github.com/matrix-org/matrix-spec-proposals/pull/4025). ([#1730](https://github.com/matrix-org/matrix-spec/issues/1730))
- Use the `body` field as optional media caption, as per [MSC2530](https://github.com/matrix-org/matrix-spec-proposals/pull/2530). ([#1731](https://github.com/matrix-org/matrix-spec/issues/1731))
- Add server support discovery endpoint, as per [MSC1929](https://github.com/matrix-org/matrix-spec-proposals/pull/1929). ([#1733](https://github.com/matrix-org/matrix-spec/issues/1733))
- Add support for multi-stream VoIP, as per [MSC3077](https://github.com/matrix-org/matrix-spec-proposals/pull/3077). ([#1735](https://github.com/matrix-org/matrix-spec/issues/1735))
- Specify that the `Retry-After` header may be used to rate-limit a client, as per [MSC4041](https://github.com/matrix-org/matrix-spec-proposals/pull/4041). ([#1737](https://github.com/matrix-org/matrix-spec/issues/1737))
- Add support for recursion on the `GET /relations` endpoints, as per [MSC3981](https://github.com/matrix-org/matrix-spec-proposals/pull/3981). ([#1746](https://github.com/matrix-org/matrix-spec/issues/1746))
**Spec Clarifications**
- The [strike](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/strike) element is deprecated in the HTML spec. Clients should prefer [s](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/s) instead. ([#1629](https://github.com/matrix-org/matrix-spec/issues/1629))
- Clarify that read receipts should be batched by thread as well as by room. ([#1685](https://github.com/matrix-org/matrix-spec/issues/1685))
- Clarify that threads can be created based on replies. ([#1687](https://github.com/matrix-org/matrix-spec/issues/1687))
- Clarify in the reply fallbacks example that the prefix sequence should be repeated for each line. ([#1690](https://github.com/matrix-org/matrix-spec/issues/1690))
- Clarify the format of account data objects for secret storage. ([#1695](https://github.com/matrix-org/matrix-spec/issues/1695), [#1734](https://github.com/matrix-org/matrix-spec/issues/1734))
- Clarify that the key backup MAC is implemented incorrectly and does not pass the ciphertext through HMAC-SHA-256. ([#1712](https://github.com/matrix-org/matrix-spec/issues/1712))
- Clarify one-time key and fallback key types in examples. ([#1715](https://github.com/matrix-org/matrix-spec/issues/1715))
- Clarify that the HKDF calculation for SAS uses base64-encoded keys rather than the raw key bytes. ([#1719](https://github.com/matrix-org/matrix-spec/issues/1719))
- Clarify how to perform the ECDH exchange in step 12 of the SAS process. ([#1720](https://github.com/matrix-org/matrix-spec/issues/1720))
- Document the deprecation policy of HTML tags, as per [MSC4077](https://github.com/matrix-org/matrix-spec-proposals/pull/4077). ([#1732](https://github.com/matrix-org/matrix-spec/issues/1732))
- The [font](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/font) element is deprecated in the HTML spec. Clients should prefer [span](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/span) with the `data-mx-bg-color` and `data-mx-color` attributes instead. ([#1739](https://github.com/matrix-org/matrix-spec/issues/1739))
- Disambiguate uses of `PublicRoomsChunk` in the `GET /hierarchy` endpoint. ([#1740](https://github.com/matrix-org/matrix-spec/issues/1740))
- Clarify that `sdpMid` and `sdpMLineIndex` are not required in `m.call.candidates`. ([#1742](https://github.com/matrix-org/matrix-spec/issues/1742))
- Fix various typos throughout the specification. ([#1748](https://github.com/matrix-org/matrix-spec/issues/1748))
- Clearly indicate that each `Content-Type` may have distinct behaviour on non-JSON requests/responses. ([#1756](https://github.com/matrix-org/matrix-spec/issues/1756))
- Clarify that the `m.push_rules` account data type cannot be set using the `/account_data` API, as per [MSC4010](https://github.com/matrix-org/matrix-spec-proposals/pull/4010). ([#1763](https://github.com/matrix-org/matrix-spec/issues/1763))
### Server-Server API
**Spec Clarifications**
- Clarify Server-Server API request signing example by using the `POST` HTTP method, as `GET` requests don't have request bodies. ([#1721](https://github.com/matrix-org/matrix-spec/issues/1721))
- Disambiguate uses of `PublicRoomsChunk` in the `GET /hierarchy` endpoint. ([#1740](https://github.com/matrix-org/matrix-spec/issues/1740))
- Clarify that the `children_state`, `room_type` and `allowed_room_ids` properties in the items of the `children` array of the response of the `GET /hierarchy` endpoint are not required. ([#1741](https://github.com/matrix-org/matrix-spec/issues/1741))
### Application Service API
**Spec Clarifications**
- Clarify that the `/login` and `/register` endpoints should fail when using the `m.login.application_service` login type without a valid `as_token`. ([#1744](https://github.com/matrix-org/matrix-spec/issues/1744))
### Identity Service API
No significant changes.
### Push Gateway API
No significant changes.
### Room Versions
**Spec Clarifications**
- For room versions 7 through 11: Clarify that `invite->knock` is not a legal transition. ([#1717](https://github.com/matrix-org/matrix-spec/issues/1717))
### Appendices
No significant changes.
### Internal Changes/Tooling
**Spec Clarifications**
- Update the spec release process. ([#1680](https://github.com/matrix-org/matrix-spec/issues/1680))
- Minor clarifications to the contributing guide. ([#1697](https://github.com/matrix-org/matrix-spec/issues/1697))
- Update Docsy to v0.8.0. ([#1699](https://github.com/matrix-org/matrix-spec/issues/1699), [#1762](https://github.com/matrix-org/matrix-spec/issues/1762))
- Fix npm release script for `@matrix-org/spec`. ([#1713](https://github.com/matrix-org/matrix-spec/issues/1713))
- Add some clarifications around implementation requirements for MSCs. ([#1718](https://github.com/matrix-org/matrix-spec/issues/1718))
- Update HTML templates to include links to object schema definitions. ([#1724](https://github.com/matrix-org/matrix-spec/issues/1724))
- Factor out all the common parameters of the various `/relations` apis. ([#1745](https://github.com/matrix-org/matrix-spec/issues/1745))
- Add support for `$ref` URIs containing fragments in OpenAPI definitions and JSON schemas. ([#1751](https://github.com/matrix-org/matrix-spec/issues/1751), [#1754](https://github.com/matrix-org/matrix-spec/issues/1754))