Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-03-23 19:44:09 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Merge branch 'main' into travis/release-steps-update-mar192024

Browse source
This commit is contained in:
Travis Ralston 2024-06-19 22:03:30 -06:00
parent 95a9905db4 9c46fa3f35
commit bb7ac504c2
307 changed files with 3970 additions and 1929 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
.github/ISSUE_TEMPLATE/release.md vendored
View file

@ -1,6 +1,6 @@
---
name: [SCT] Release checklist
about: Used by the Spec Core Team to create a new release.
name: '[SCT] Release checklist'
about: 'Used by the Spec Core Team to create a new release.'
title: 'Matrix 1.X'
labels: 'release-blocker'
assignees: ''

1
.github/_typos.toml vendored
View file

@ -10,3 +10,4 @@ au1ba7o = "au1ba7o"
[default.extend-words]
Appy = "Appy"
fo = "fo"
Iy = "Iy"

8
.github/PULL_REQUEST_TEMPLATE/spec-change.md → .github/pull_request_template.md vendored
View file

@ -1,11 +1,3 @@
---
name: Spec clarification/not a proposal
about: A change that's not a spec proposal, such as a clarification to the spec itself.
title: ''
labels: ''
assignees: ''
---
### Pull Request Checklist

61
.github/workflows/main.yml vendored
View file

@ -20,9 +20,9 @@ jobs:
- name: "📥 Source checkout"
uses: actions/checkout@v4
- name: "➕ Setup Node"
uses: actions/setup-node@v3
uses: actions/setup-node@v4
with:
node-version: '18'
node-version: '20'
- name: "🔎 Run validator"
run: |
npx @redocly/cli@latest lint data/api/*/*.yaml
@ -34,7 +34,7 @@ jobs:
- name: "📥 Source checkout"
uses: actions/checkout@v4
- name: "➕ Setup Python"
uses: actions/setup-python@v4
uses: actions/setup-python@v5
with:
python-version: '3.9'
cache: 'pip'
@ -45,15 +45,15 @@ jobs:
- name: "🔎 Run validator"
run: |
python scripts/check-event-schema-examples.py
check-openapi-examples:
name: "🔎 Check OpenAPI definitions examples"
runs-on: ubuntu-latest
steps:
- name: "📥 Source checkout"
uses: actions/checkout@v2
uses: actions/checkout@v4
- name: "➕ Setup Python"
uses: actions/setup-python@v4
uses: actions/setup-python@v5
with:
python-version: '3.9'
cache: 'pip'
@ -70,9 +70,9 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: "📥 Source checkout"
uses: actions/checkout@v2
uses: actions/checkout@v4
- name: "➕ Setup Python"
uses: actions/setup-python@v4
uses: actions/setup-python@v5
with:
python-version: '3.9'
cache: 'pip'
@ -99,11 +99,11 @@ jobs:
# the asterisk matching behaviour, not the literal string.
run: |
if [ "${GITHUB_EVENT_NAME}" == "pull_request" ]; then
echo ::set-output name=baseURL::/
echo "baseURL=/" >> "$GITHUB_OUTPUT"
elif [[ "${GITHUB_REF}" == refs/tags/* ]]; then
echo ::set-output name=baseURL::"/${GITHUB_REF/refs\/tags\//}"
echo "baseURL=/${GITHUB_REF/refs\/tags\//}" >> "$GITHUB_OUTPUT"
else
echo ::set-output name=baseURL::/unstable
echo "baseURL=/unstable" >> "$GITHUB_OUTPUT"
fi
build-openapi:
@ -114,7 +114,7 @@ jobs:
- name: "📥 Source checkout"
uses: actions/checkout@v4
- name: "➕ Setup Python"
uses: actions/setup-python@v4
uses: actions/setup-python@v5
with:
python-version: '3.9'
cache: 'pip'
@ -152,7 +152,7 @@ jobs:
-o spec/server-server-api/api.json
tar -czf openapi.tar.gz spec
- name: "📤 Artifact upload"
uses: actions/upload-artifact@v3
uses: actions/upload-artifact@v4
with:
name: openapi-artifact
path: openapi.tar.gz
@ -166,13 +166,15 @@ jobs:
- name: "📥 Source checkout"
uses: actions/checkout@v4
- name: "➕ Setup Python"
uses: actions/setup-python@v4
uses: actions/setup-python@v5
with:
python-version: '3.9'
- name: "➕ Install towncrier"
run: "pip install 'towncrier'"
- name: "Generate changelog"
run: ./scripts/generate-changelog.sh vUNSTABLE
- name: "📤 Artifact upload"
uses: actions/upload-artifact@v3
uses: actions/upload-artifact@v4
with:
name: changelog-artifact
path: content/changelog/vUNSTABLE.md
@ -185,13 +187,13 @@ jobs:
if: ${{ always() }}
steps:
- name: "➕ Setup Node"
uses: actions/setup-node@v3
uses: actions/setup-node@v4
with:
node-version: '18'
node-version: '20'
- name: "➕ Setup Hugo"
uses: peaceiris/actions-hugo@16361eb4acea8698b220b76c0d4e84e1fd22c61d
uses: peaceiris/actions-hugo@75d2e84710de30f6ff7268e08f310b60ef14033f # v3.0.0
with:
hugo-version: '0.113.0'
hugo-version: '0.117.0'
extended: true
- name: "📥 Source checkout"
uses: actions/checkout@v4
@ -201,7 +203,7 @@ jobs:
npm run get-proposals
- name: "📥 Download generated changelog"
if: "needs.generate-changelog.result == 'success'"
uses: actions/download-artifact@v3
uses: actions/download-artifact@v4
with:
name: changelog-artifact
path: content/changelog
@ -212,7 +214,7 @@ jobs:
# https://spec.matrix.org/latest/client-server-api/api.json
# Works for /unstable/ and /v1.1/ as well.
- name: "📥 Spec definition download"
uses: actions/download-artifact@v3
uses: actions/download-artifact@v4
with:
name: openapi-artifact
- name: "📝 Unpack the OpenAPI definitions in the right location"
@ -222,7 +224,7 @@ jobs:
- name: "📦 Tarball creation"
run: tar -czf spec.tar.gz spec
- name: "📤 Artifact upload"
uses: actions/upload-artifact@v3
uses: actions/upload-artifact@v4
with:
name: spec-artifact
path: spec.tar.gz
@ -236,7 +238,7 @@ jobs:
uses: actions/checkout@v4
- name: "📥 Fetch built spec"
uses: actions/download-artifact@v3
uses: actions/download-artifact@v4
with:
name: spec-artifact
@ -262,13 +264,14 @@ jobs:
if: ${{ startsWith(github.ref, 'refs/tags/') }}
steps:
- name: "➕ Setup Node"
uses: actions/setup-node@v3
uses: actions/setup-node@v4
with:
node-version: '18'
node-version: '20'
- name: "➕ Setup Hugo"
uses: peaceiris/actions-hugo@16361eb4acea8698b220b76c0d4e84e1fd22c61d
uses: peaceiris/actions-hugo@75d2e84710de30f6ff7268e08f310b60ef14033f # v3.0.0
with:
hugo-version: '0.93.3'
# Cannot build the spec with Hugo 0.125.0 because of https://github.com/google/docsy/issues/1930
hugo-version: '0.124.1'
extended: true
- name: "📥 Source checkout"
uses: actions/checkout@v4
@ -283,7 +286,7 @@ jobs:
hugo --config config.toml,historical.toml --baseURL "/${GITHUB_REF/refs\/tags\//}" -d "spec"
- name: "📥 Spec definition download"
uses: actions/download-artifact@v3
uses: actions/download-artifact@v4
with:
name: openapi-artifact
- name: "📝 Unpack the OpenAPI definitions in the right location"
@ -293,7 +296,7 @@ jobs:
- name: "📦 Tarball creation"
run: tar -czf spec-historical.tar.gz spec
- name: "📤 Artifact upload"
uses: actions/upload-artifact@v3
uses: actions/upload-artifact@v4
with:
name: spec-historical-artifact
path: spec-historical.tar.gz

12
.github/workflows/netlify.yaml vendored
View file

@ -25,17 +25,20 @@ jobs:
id: readctx
# we need to find the PR number that corresponds to the branch, which we do by
# searching the GH API
env:
OWNER_LOGIN: ${{ github.event.workflow_run.head_repository.owner.login }}
HEAD_BRANCH: ${{ github.event.workflow_run.head_branch }}
run: |
head_branch='${{github.event.workflow_run.head_repository.owner.login}}:${{github.event.workflow_run.head_branch}}'
head_branch="${OWNER_LOGIN}:${HEAD_BRANCH}"
echo "head branch: $head_branch"
pulls_uri="https://api.github.com/repos/${{ github.repository }}/pulls?head=$(jq -Rr '@uri' <<<$head_branch)"
pr_number=$(curl -H 'Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}' "$pulls_uri" |
jq -r '.[] | .number')
echo "PR number: $pr_number"
echo "::set-output name=prnumber::$pr_number"
echo "prnumber=$pr_number" >> "$GITHUB_OUTPUT"
- name: '📥 Download artifact'
uses: dawidd6/action-download-artifact@268677152d06ba59fcec7a7f0b5d961b6ccd7e1e # v2.28.0
uses: dawidd6/action-download-artifact@09f2f74827fd3a8607589e5ad7f9398816f540fe # v3.1.4
with:
workflow: main.yaml
run_id: ${{ github.event.workflow_run.id }}
@ -46,8 +49,7 @@ jobs:
- name: "📤 Deploy to Netlify"
id: netlify
# v2.1.0
uses: nwtgck/actions-netlify@7a92f00dde8c92a5a9e8385ec2919775f7647352
uses: nwtgck/actions-netlify@4cbaf4c08f1a7bfa537d6113472ef4424e4eb654 # v3.0.0
with:
publish-dir: spec
deploy-message: "Deploy from GitHub Actions"

7
.github/workflows/release.yaml vendored
View file

@ -17,7 +17,7 @@ jobs:
uses: actions/checkout@v4
- name: 🔧 Yarn cache
uses: actions/setup-node@v3
uses: actions/setup-node@v4
with:
cache: "yarn"
cache-dependency-path: packages/npm/yarn.lock
@ -26,14 +26,15 @@ jobs:
- name: 🔨 Install dependencies
run: "yarn install --frozen-lockfile"
# We bump the package.json version to git, we just need it for publish to do the right thing
- name: 🎖 Bump package.json version
run: "yarn version --new-version $VERSION"
run: "yarn version --new-version ${VERSION#v} --no-git-tag-version"
env:
VERSION: ${{ github.event.release.tag_name }}.0
- name: 🚀 Publish to npm
id: npm-publish
uses: JS-DevTools/npm-publish@5a85faf05d2ade2d5b6682bfe5359915d5159c6c # v2.2.1
uses: JS-DevTools/npm-publish@19c28f1ef146469e409470805ea4279d47c3d35c # v3.1.1
with:
token: ${{ secrets.NPM_TOKEN }}
package: packages/npm

4
.github/workflows/spell-check.yaml vendored
View file

@ -14,6 +14,6 @@ jobs:
uses: actions/checkout@v4
- name: Check spelling of proposals
uses: crate-ci/typos@ff3f309513469397e1094520fb7a054e057589e1
uses: crate-ci/typos@f2c1f08a7b3c1b96050cb786baaa2a94797bdb7d # v1.20.10
with:
config: ${{github.workspace}}/.github/_typos.toml
config: ${{github.workspace}}/.github/_typos.toml

1
.htmltest.yaml
View file

@ -4,3 +4,4 @@
IgnoreDirectoryMissingTrailingSlash: true
DirectoryPath: spec
CheckExternal: false
IgnoreInternalEmptyHash: true

4
CONTRIBUTING.rst
View file

@ -12,7 +12,7 @@ The documentation style is described at
https://github.com/matrix-org/matrix-spec/blob/main/meta/documentation_style.rst.
Matrix-spec workflows
--------------------
---------------------
Specification changes
~~~~~~~~~~~~~~~~~~~~~
@ -117,7 +117,7 @@ license - in our case, this is Apache Software License v2 (see LICENSE).
In order to have a concrete record that your contribution is intentional
and you agree to license it under the same terms as the project's license, we've adopted the
same lightweight approach used by the `Linux Kernel <https://www.kernel.org/doc/html/latest/process/submitting-patches.html>`_,
`Docker <https://github.com/docker/docker/blob/master/CONTRIBUTING.md`_, and many other
`Docker <https://github.com/docker/docker/blob/master/CONTRIBUTING.md>`_, and many other
projects: the `Developer Certificate of Origin <http://developercertificate.org/>`_
(DCO). This is a simple declaration that you wrote
the contribution or otherwise have the right to contribute it to Matrix::

2
README.md
View file

@ -61,7 +61,7 @@ place after an MSC has been accepted, not as part of a proposal itself.
1. Install the extended version (often the OS default) of Hugo:
<https://gohugo.io/getting-started/installing>. Note that at least Hugo
v0.110.0 is required.
v0.117.0 is required.
Alternatively, use the Docker image at
https://hub.docker.com/r/klakegg/hugo/. (The "extended edition" is required

49
assets/scss/_styles_project.scss
View file

@ -40,10 +40,13 @@ Custom SCSS for the Matrix spec
.navbar-brand {
font-size: 1.1rem;
/* Allow the text to wrap if it is wider than the viewport */
text-align: center;
white-space: normal;
.navbar-version {
color: $secondary;
}
}
.nav-link {
@ -115,7 +118,7 @@ Custom SCSS for the Matrix spec
}
}
@media (min-width: 768px) {
@include media-breakpoint-up(md) {
@supports (position: sticky) {
.td-sidebar-nav {
/* This overrides calc(100vh - 10rem);, which gives us a blank space at the bottom of the sidebar */
@ -172,6 +175,13 @@ footer {
}
/* Remove some padding before the main content, when the sidebar is disabled */
.td-main main {
@include media-breakpoint-down(md) {
padding-top: 0;
}
}
/* Adjust the scroll margin for everything in the main content, so that
* it doesn't disappear behind the header bar */
.td-content * {
@ -427,6 +437,31 @@ footer {
&.basic-info th {
width: 15rem;
}
/* Arrange rows vertically when horizontal space is constrained to avoid overflowing */
@include media-breakpoint-down(sm) {
/* Make cells full width without vertical margin */
&.basic-info th, &.basic-info td {
width: 100%;
display: inline-block;
margin-top: 0;
margin-bottom: 0;
}
/* Remove border and padding between header & data cells to make them appear like a single cell */
&.basic-info td {
padding-top: 0;
border-top: none;
}
&.basic-info th {
border-bottom: none;
}
/* Remove top border on all but the first header cell to prevent double borders between rows */
&.basic-info tr + tr th {
border-top: none;
}
}
}
pre {
@ -471,12 +506,18 @@ of .td-content. This applies the same style to any blockquotes that descend from
Make padding symmetrical (this selector is used in the default styles to apply padding-left: 3rem)
*/
.pl-md-5, .px-md-5 {
padding-right: 3rem;
@include media-breakpoint-up(md) {
padding-right: 3rem;
}
}
/* Adjust default styles for info banner */
.pageinfo-primary {
max-width: 80%;
@include media-breakpoint-up(lg) {
max-width: 80%;
}
margin-top: 0;
margin-right: 0;
margin-left: 0;
border: 0;
border-left: solid 5px $secondary;

3
assets/scss/_variables_project.scss
View file

@ -49,3 +49,6 @@ $td-enable-google-fonts: false;
* The font itself is loaded via stylesheet link layouts/partials/hooks/head-end.html.
*/
$font-family-sans-serif: "Inter", -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
// Disable smooth scrolling as it makes TOC highlighting jump during the transition.
$enable-smooth-scroll: false;

1
changelogs/appendices/newsfragments/1791.clarification Normal file
View file

@ -0,0 +1 @@
Define 'Opaque Identifier Grammar'.

1
changelogs/appendices/newsfragments/1819.clarification Normal file
View file

@ -0,0 +1 @@
Define common cryptographic key representation.

1
changelogs/appendices/newsfragments/1823.deprecation Normal file
View file

@ -0,0 +1 @@
Deprecate linking to events in rooms identified by alias, as per [MSC4132](https://github.com/matrix-org/matrix-spec-proposals/pull/4132).

1
changelogs/appendices/newsfragments/1850.clarification Normal file
View file

@ -0,0 +1 @@
Move size limits for user, room and event IDs into the appendix and clarify that the length is to be measured in bytes.

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/application_service/newsfragments/1810.clarification Normal file
View file

@ -0,0 +1 @@
Clarify that appservices should be notified of events relating to the `sender_localpart` user.

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/1644.clarification Normal file
View file

@ -0,0 +1 @@
Add `/logout` and clarify the endpoints which do not take a JSON request body.

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/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/1755.feature Normal file
View file

@ -0,0 +1 @@
Add support for muting in VoIP calls, as per [MSC3291](https://github.com/matrix-org/matrix-spec-proposals/pull/3291).

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

@ -0,0 +1 @@
Add optional `animated` query string option to `GET /thumbnail`, as per [MSC2705](https://github.com/matrix-org/matrix-spec-proposals/pull/2705).

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

@ -0,0 +1 @@
Clarify that the `type` of the `POST /login` request must be one of the types returned by the `GET /login` response.

1
changelogs/client_server/newsfragments/1808.deprecation Normal file
View file

@ -0,0 +1 @@
Authentication using a query string is now deprecated, as per [MSC4126](https://github.com/matrix-org/matrix-spec-proposals/issues/4126). The `Authorization` header should be used instead.

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

@ -0,0 +1 @@
Specify terms of services at registration, as per [MSC1692](https://github.com/matrix-org/matrix-spec-proposals/pull/1692).

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

@ -0,0 +1 @@
Link to existing grammar where possible in types.

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

@ -0,0 +1 @@
Add support for mathematical messages, as per [MSC2191](https://github.com/matrix-org/matrix-spec-proposals/pull/2191).

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

@ -0,0 +1 @@
Rename "recovery key" to "backup decryption key".

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

@ -0,0 +1 @@
Do not require UIA when first uploading cross-signing keys, as per [MSC3967](https://github.com/matrix-org/matrix-spec-proposals/pull/3967).

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

@ -0,0 +1 @@
Clarify that the device's Ed25519 signing key should be used in QR code verification (as opposed to the device's Curve25519 identity key).

0
changelogs/client_server/newsfragments/1748.clarification → changelogs/client_server/newsfragments/1832.clarification
View file

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

@ -0,0 +1 @@
Specify the encoding to be used when generating QR codes for device verification.

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

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

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

@ -0,0 +1 @@
Clarify that an access token is optional on the `POST /account/password` and `POST /account/deactivate` endpoints.

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

@ -0,0 +1 @@
Use RFC 2119 keywords more consistently.

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

@ -0,0 +1 @@
Add the new `unsigned.membership` property to events, as per [MSC4115](https://github.com/matrix-org/matrix-spec-proposals/pull/4115).

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

@ -0,0 +1 @@
Move size limits for user, room and event IDs into the appendix and clarify that the length is to be measured in bytes.

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

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

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

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

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

@ -0,0 +1 @@
Clarify that relations recursion should be capped at a certain depth.

1
changelogs/client_server/newsfragments/1858.deprecation Normal file
View file

@ -0,0 +1 @@
Use of the `/_matrix/media/*` endpoints is now deprecated. New, authenticated, endpoints are available instead.

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

@ -0,0 +1 @@
Media downloads and thumbnails are now authenticated, as per [MSC3916](https://github.com/matrix-org/matrix-spec-proposals/pull/3916).

1
changelogs/client_server/newsfragments/1858.feature.2 Normal file
View file

@ -0,0 +1 @@
Some media endpoints are now consistently under `/_matrix/client/{version}/media/*` instead of `/_matrix/media/*`, as per [MSC3916](https://github.com/matrix-org/matrix-spec-proposals/pull/3916).

1
changelogs/client_server/newsfragments/1858.new.1 Normal file
View file

@ -0,0 +1 @@
[`GET /_matrix/client/v1/media/config`](/client-server-api/#get_matrixclientv1mediaconfig)

1
changelogs/client_server/newsfragments/1858.new.2 Normal file
View file

@ -0,0 +1 @@
[`GET /_matrix/client/v1/media/download/{serverName}/{mediaId}`](/client-server-api/#get_matrixclientv1mediadownloadservernamemediaid)

1
changelogs/client_server/newsfragments/1858.new.3 Normal file
View file

@ -0,0 +1 @@
[`GET /_matrix/client/v1/media/download/{serverName}/{mediaId}/{fileName}`](/client-server-api/#get_matrixclientv1mediadownloadservernamemediaidfilename)

1
changelogs/client_server/newsfragments/1858.new.4 Normal file
View file

@ -0,0 +1 @@
[`GET /_matrix/client/v1/media/preview_url`](/client-server-api/#get_matrixclientv1mediapreview_url)

1
changelogs/client_server/newsfragments/1858.new.5 Normal file
View file

@ -0,0 +1 @@
[`GET /_matrix/client/v1/media/thumbnail/{serverName}/{mediaId}`](/client-server-api/#get_matrixclientv1mediathumbnailservernamemediaid)

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

@ -0,0 +1 @@
Add missing secrets, third-party invites and room tagging modules to feature profiles table.

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

@ -0,0 +1 @@
Use RFC 2119 keywords more consistently.

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

@ -0,0 +1 @@
Clarify when server name is used and link to the definition.

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

@ -0,0 +1 @@
Clarify where keys reside when checking an `m.room.encrypted` event.

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

@ -0,0 +1 @@
Clarify that `/media/v3/upload/{serverName}/{mediaId}` requires authentication.

1
changelogs/identity_service/newsfragments/1808.deprecation Normal file
View file

@ -0,0 +1 @@
Authentication using a query string is now deprecated, as per [MSC4126](https://github.com/matrix-org/matrix-spec-proposals/issues/4126). The `Authorization` header should be used instead.

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

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

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/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.

0
changelogs/internal/newsfragments/1713.clarification → changelogs/internal/newsfragments/1765.clarification
View file

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

@ -0,0 +1 @@
Formatting fixes in `CONTRIBUTING.rst`.

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

@ -0,0 +1 @@
Improve rendering on mobile devices.

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

@ -0,0 +1 @@
Improve rendering on mobile devices.

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

@ -0,0 +1 @@
Fix the OpenAPI definition of the security schemes.

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

@ -0,0 +1 @@
Simplify uses of `resolve-refs` partial.

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

@ -0,0 +1 @@
Fix Hugo warnings.

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

@ -0,0 +1 @@
Fix `github-labels.rst`.

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

@ -0,0 +1 @@
Update dependencies.

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

@ -0,0 +1 @@
Solve `allOf` recursively in OpenAPI and JSON Schemas.

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

@ -0,0 +1 @@
Fix Hugo warnings.

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

@ -0,0 +1 @@
Fix property type resolution in `render-object-table` partial.

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

@ -0,0 +1 @@
Factor out common definition of `Tag` type.

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

@ -0,0 +1 @@
Update the version of Hugo used to render the spec to v0.124.1.

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

@ -0,0 +1 @@
Add support for pattern formats for `patternProperties`.

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

@ -0,0 +1 @@
Clean up unnecessary `allOf`s in OpenAPI definitions.

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

@ -0,0 +1 @@
Show information about "Additional Properties" in object tables.

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

@ -0,0 +1 @@
Fix anchors for schemas under `oneOf`.

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

@ -0,0 +1 @@
Use reference to `OneTimeKeys` schema in OpenAPI definitions.

Some files were not shown because too many files have changed in this diff Show more