Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-02-23 14:33:43 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
6989 commits 28 branches 42 tags 35 MiB
Commit graph

410 commits

Author SHA1 Message Date
Tom Foster dd4ea948b6 Clarify why avatar_url and displayname can't be returned as null 2025-02-21 09:53:43 +00:00
Tom Foster 50eab3501e Standardise line-wrapping and update avatar_url format to mx-mxc-uri 2025-02-21 09:28:46 +00:00
Tom Foster 37b1362bc1 Attempt to describe variable payload content 2025-02-20 18:08:10 +00:00
Tom Foster d8cc250d20 Tag x-addedInMatrixVersion on additionalProperties in entire profile GET 2025-02-20 17:02:23 +00:00
Tom Foster b5e2edf2e5 Add x-addedInMatrixVersion 2025-02-20 16:59:44 +00:00
Tom Foster 7ef1d9d0ec Add x-changedInMatrixVersion 2025-02-20 16:56:53 +00:00
Tom Foster 3a5e5555fa Correct PUT/GET payload definitions 2025-02-20 16:48:20 +00:00
Tom Foster 9889fe3584 Use more accessible terminology than "glob" 2025-02-20 16:40:07 +00:00
Tom Foster 013502b0c0 Mention replacement for m.set_displayname and m.set_avatar_url capability deprecation 2025-02-20 16:35:26 +00:00
Tom Foster 9859e20927 Don't use reference for capability. 2025-02-20 16:31:27 +00:00
Tom Foster 0b0942d192 Clarify capability lists should support wildcards 2025-02-14 15:00:53 +00:00
Tom Foster 1cc93ec951 Attempt to make descriptions look better in HTML rendered spec 2025-02-14 14:53:29 +00:00
Tom Foster 79af78022e Camel case for endpoint variables 2025-02-14 13:47:49 +00:00
Tom Foster 79a1cded02 Remove reference to spec version in m.profile_field capability 2025-02-14 12:57:51 +00:00
Tom Foster 76b48e25d0 Specify CNIG pattern for custom fields 2025-02-14 12:56:16 +00:00
Tom Foster 5d5b561140 Deprecate m.set_displayname and m.set_avatar_url capabilities 2025-02-14 12:47:14 +00:00
Tom Foster 9327793007 Inline information from MSC4133, remove links 2025-02-14 12:39:19 +00:00
Tom Foster f3c269d951 Added capability 2025-02-14 12:20:25 +00:00
Patrick Cloke cb83c5a76e
Clarify which rooms are returned from /hierarchy (#2064) 
Signed-off-by: Patrick Cloke <clokep@patrick.cloke.us>
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
 2025-02-14 12:06:21 +00:00
Tom Foster 3311b084bf Alphabetise avatar_url and displayname and remove redundant descriptions on displayname 2025-02-14 12:03:49 +00:00
Tom Foster 992cf9dc35 Clarify null behaviour for PUT and DELETE 2025-02-14 11:53:19 +00:00
Tom Foster 4f8999be0a Tweak wording on full profile GET 2025-02-14 11:32:39 +00:00
Tom Foster 82adcec491 Clarify avatar_url should be MXC 2025-02-14 11:21:45 +00:00
Tom Foster ee9b5ddcca Correct types and errors 2025-02-14 11:02:11 +00:00
Tom Foster 59d2c62d2d Link to MSC4133 in endpoint descriptions 2025-02-14 10:40:09 +00:00
Tom Foster 212377e393
Merge branch 'matrix-org:main' into MSC4133 2025-02-14 09:50:59 +00:00
Tom Foster fdc012ac01 Describe MSC4133 profile endpoint changes 2025-02-13 17:54:21 +00:00
Kévin Commaille c2ef38f0e5
Document instance_id field of /thirdparty/protocols (#2051) 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2025-02-13 17:29:56 +00:00
Johannes Marbach 23e709ae9b
MSC4213: Remove server_name parameter (#2059) 
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
 2025-02-11 18:03:25 +00:00
Kévin Commaille a1bdfaa167
Remove the origin field in PUT /send_join responses (#2050) 
* Remove the `origin` field on PUT /send_join responses

This is a spec bug as it has actually never been sent by Synapse, going back to 2014.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Add changelog

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

---------

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2025-01-21 22:55:27 +00:00
Kévin Commaille d0d71d9997
Clarify formats of string types in account sections (#2046) 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2025-01-17 17:18:51 +00:00
Johannes Marbach 42364c5155
Fix typo in /_matrix/client/v3/rooms/{roomId}/redact/{eventId}/{txnId} (#2047) 
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
 2025-01-14 18:52:56 +00:00
morguldir e341525e04
Undeprecate /initialSync for peeking (#2036) 
Signed-off-by: morguldir <morguldir@protonmail.com>
 2025-01-14 18:50:30 +00:00
Kim Brose 2df3f7a7bf
Clarify wording in the /join endpoints summaries and descriptions (#2038) 2024-12-20 11:59:42 +00:00
Andy Balaam 35c3ddb33b
Specify the order in which one-time keys are returned (MSC4225) (#2029) 
Signed-off-by: Andy Balaam <andy.balaam@matrix.org>
 2024-12-12 15:53:21 +00:00
Kévin Commaille 96b32f68f9
Allow sending ephemeral data to application services (#2018) 
As per MSC2409.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2024-12-11 22:38:59 +00:00
David Baker 9198182f1a
Add error codes from MSC4178 (#1944) 
* Add error codes from MSC4178

* changelog

* Put changelog in the right place

* Move newsfile

* Add the codes to the right endpoint

* Also add M_THREEPID_IN_USE

which was always used and is specified in the IS API, but not in the
C/S API. We decided this was well-specced enough that it didn't need
its own MSC.
 2024-12-11 09:48:26 +00:00
Kévin Commaille 54d872e19b
Fix added-in Matrix spec version for report room endpoint (#2028) 
See #1938 where they were incorrectly marked as 1.12 instead of 1.13.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2024-12-09 10:13:36 -05:00
Richard van der Hoff f8119f5336
Remove distinction between StateFilter and RoomEventFilter (#2015) 
They are exactly the same type, so let's combine their tables together.
 2024-11-27 17:11:39 +01:00
Kévin Commaille bf8dee74eb
Fix relative URLs when serving the specification with a custom baseURL (#1984) 2024-11-14 11:11:34 +00:00
DeepBlueV7.X 9799b892de
Clarify parameter definition for third-party location lookups (#1947) 
While 1405184765 redefined most fields to
be the appropriate object type, it missed one of them.

Signed-off-by: Nicolas Werner <nicolas.werner@hotmail.de>
 2024-11-12 22:24:20 +00:00
Johannes Marbach 74e8be3fd9
Clarify that pusher URLs have a fixed path (#1974) 
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
 2024-11-07 14:56:53 +00:00
Kévin Commaille 909c4614ac
Clarify formats of string types for the GET /.well-known/matrix/support endpoint (#1978) 2024-11-06 15:16:34 +00:00
Benjamin Bouvier 6cd7038d01
Clarify that the async upload endpoint will return 404 in some cases (#1983) 2024-11-06 11:28:47 +00:00
Kévin Commaille e0bd054373
Clarify formats of string types for the POST /_matrix/client/v3/login endpoint (#1980) 
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
 2024-11-06 11:14:24 +00:00
Kévin Commaille f730987da6
Clarify format of string type for m.login.terms_params (#1979) 2024-11-06 10:49:38 +00:00
Kévin Commaille 1e0919ad12
Rename custom-formats.yaml to string-formats.yaml (#1977) 
It does not contain only custom formats, so the name didn't fit anymore.
Update also the docs to reflect that.
 2024-10-30 22:30:31 +00:00
Johannes Marbach 88f0c56ad9
Clarify that servers must forward custom keys in PusherData (#1973) 
Relates to: #921
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
 2024-10-30 10:33:44 +00:00
Srinjoy Sen Chowdhury 0b4d1c0237
Add 403 error response to federation/v1/state_ids (#1926) 
fixes #1912 by adding a 403 error response to /_matrix/federation/v1/state_ids/{roomId}

Signed-off-by: Srinjoy Sen Chowdhury  <srinjoysen123@gmail.com>
 2024-10-30 10:30:05 +00:00
Kévin Commaille 611d6c3e7e
Always use % delimiter for added-in and changed-in shortcodes (#1975) 
The `<>` delimiters are not necessary for the shortcode to be rendered inline, and in some cases they break some expectations: a shortcode that is separated from other text to be in its own paragraph is not actually wrapped by a `p` element, breaking the spacing between paragraphs.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2024-10-30 10:09:38 +00:00
Johannes Marbach 32f41f88bc
Document schema of PusherData in push gateway API (#1968) 
Fixes: #910
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
 2024-10-29 15:10:59 +00:00
Johannes Marbach 285cd2bda2
Sort VoIP events semantically (#1967) 2024-10-15 17:22:40 +01:00
Johannes Marbach c74105db43
MSC4151: Reporting rooms (#1938) 2024-10-10 10:53:44 +01:00
Johannes Marbach 871c10577e
MSC4170: 403 error responses for profile APIs (#1867) 
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
 2024-10-07 10:45:17 +01:00
Kévin Commaille 27b4cdcc9e
Add the deprecated field to OpenAPI definitions and JSON Schemas (#1940) 
I did a quick search of the "deprecated" word in the data folder and set the
field where the description says that a property is deprecated.

This does not change the rendering of the spec because the
descriptions already talk about the deprecation,
but it can be used by tools that rely on the OpenAPI definitions and JSON Schemas.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2024-10-01 14:39:57 +01:00
Johannes Marbach 2cbf6067a6
Use "server name" instead of "DNS name" to avoid confusion (#1946) 
Fixes: #1911

Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
 2024-09-11 08:56:14 -04:00
Johannes Marbach 75e77b96ff
Additional keys in GET /capabilities don't have to be objects (#1945) 2024-09-11 13:51:27 +02:00
Kévin Commaille 415fb43848
Specify Content-Type and Content-Disposition usage in the media repo (#1935) 2024-09-02 10:41:33 +02:00
Johannes Marbach 7f2f100420
MSC4156: Migrate server_name to via (#1933) 
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
 2024-08-28 13:42:30 +01:00
Tulir Asokan 87de68c35e
Fix required fields in /_matrix/key/v2/server response schema (#1930) 
Fixes #613
 2024-08-14 20:51:12 +03:00
Johannes Marbach f9c4aeeea4
Remove leftover origin field from unsigned PDU example (#1918) 2024-08-12 12:01:54 +01:00
Johannes Marbach c2fd278da0
Additional .well-known keys don't have to be objects (#1920) 2024-08-12 10:53:18 +01:00
Patrick Cloke 56914b72ef
Remove references to device-specific push rules. (#1842) 
Device-specific push rules have never been implemented and aren't properly specified.
 2024-08-01 10:33:41 -04:00
Johannes Marbach 9bac118aec
Clarify that the User identifier object in POST /_matrix/client/v3/login contains additional properties that depend on the identification type (#1909) 
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
 2024-07-30 17:37:49 +00:00
Johannes Marbach 5d91b628c9
Don't mention that GET /_matrix/client/v3/profile/{userId} can return additional properties because this is true for almost every endpoint (#1910) 
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
 2024-07-30 18:37:29 +01:00
Johannes Marbach d9c447e194
Document m.get_login_token capability (#1908) 2024-07-19 11:13:10 +01:00
Johannes Marbach cbe8092d8a
Spec for MSC2867 (Marking rooms as unread) (#1895) 
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
 2024-07-15 14:38:57 +01:00
Johannes Marbach 40d5e48716
Add missing references in capabilities table (#1897) 
* Add missing references in capabilities table

Fixes: #1548
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>

* Add changelog

---------

Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
 2024-07-10 12:13:37 -04:00
Johannes Marbach d528ff684b
Fix minor typos in third-party networks module (#1892) 2024-06-28 08:14:32 -04:00
Johannes Marbach 7820771fdd
Clarify that room avatars cannot be encrypted (#1871) 
Fixes: #562
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
 2024-06-25 15:40:21 +01:00
Kévin Commaille bd20d946c4
Fix the rendering of the event format for room versions 1 and 2 (#1883) 
* Fix rendering of array with items using anyOf

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Use a single definition for Event Hash

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Add changelog

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Add ending newline

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

---------

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2024-06-20 09:39:44 -06:00
Kévin Commaille 094e25b6cd
Ensure more uniqueness for generated HTML IDs (#1881) 
* Include method in all API endpoint children's IDs

Avoids duplicate IDs for object of endpoints
that use the same path but a different method.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Differentiate API endpoints' request and response children's IDs

Ensures that the objects have a unique ID compared to other parts of the endpoint.
Mostly useful for the Error type that can be used for responses with different status codes.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Differentiate the names of both SessionData formats

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Add changelog

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

---------

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2024-06-20 09:36:33 -06:00
Johannes Marbach 27e71fff10
Render added/changed in info on request and response content types (#1876) 
* Render added/changed in info on request and response content types

Fixes: #1774
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
Co-authored-by: Kévin Commaille <76261501+zecakeh@users.noreply.github.com>
 2024-06-20 09:46:33 +01:00
Kévin Commaille 4e32fca05f
Clarify that an access token is optional on /account/password and /account/deactivate (#1843) 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
 2024-06-18 16:59:26 +01:00
Johannes Marbach 7773716d18
Clarify that asynchronous media upload requires authentication (#1872) 
Fixes: #1554
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
 2024-06-14 10:44:01 -04:00
Kévin Commaille f434fdfba7
Replace references to obsolete RFC 1341 with RFC 2046 (#1869) 
* Replace references to obsolete RFC 1341 with RFC 2046

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Add changelog

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

---------

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2024-06-13 15:37:07 -06:00
Johannes Marbach 672af37cbd
Clarify that relations recursion should be capped at a certain depth (#1854) 2024-06-13 14:34:54 -04:00
Travis Ralston f38b052569
Use RFC 2119 keywords across the content repository spec (#1861) 
* Use RFC 2119 keywords across the content repository spec

* changelog
 2024-06-13 12:27:06 -06:00
Travis Ralston 7a51ae879c
Add authenticated media (MSC3916) (#1858) 
* C2S: Deprecate now-legacy endpoints

* C2S: Fix MXC URI code block while we're here

* C2S: Describe the authentication and deprecation requirements

* C2S: Intro the upload/download endpoints differently

* C2S: Literally copy/paste the `content-repo.yaml` spec

* C2S: Drop `/upload` and `/create` because we aren't replacing them today

* C2S: Fix notes while we're here

* C2S: Update metadata for new endpoints

* C2S: Add authentication to new endpoints

* C2S: Drop `allow_remote` and `allow_redirect` on new endpoints

* C2S: Append backwards compatibility notes

* C2S: Decorate old media endpoints with pointers to the new ones

The server-server spec might have a harder time linking to these, but that can be fixed with verbiage.

* C2S: Annotate IdP icon spec with media auth implications

* S2S: Modernize section text

* S2S: Create content repository API

This is largely a copy/paste of the new authed content repo API in the Client-Server API, though some keywords (like "client") have been changed. Paths and response formats have also been changed to support the federation-specific requirements.

* C2S & S2S: Add plethora of changelogs

* Reference RFC 1341

* Upgrade keywords in changed text

* Mention caching

* Cross-reference IdP icons

* Update content/client-server-api/modules/content_repo.md
 2024-06-13 18:08:27 +00:00
Patrick Cloke da3e884aaa
Fix broken link to push rule condition kinds. (#1841) 2024-06-11 21:42:46 +00:00
Patrick Cloke a7a7eadf2c
Clarify when an event is returned from /send_join. (#1840) 2024-06-11 13:02:46 -04:00
Richard van der Hoff 96057638ce
Spec unsigned.membership property, per MSC4115 (#1847) 2024-06-10 12:17:27 +00:00
Johannes Marbach 1b40a7789b
Fix typos around relations recursion (#1853) 2024-06-10 07:26:50 -04:00
Johannes Marbach 5a86e384dd
Clarify that per-request UIA for /login/get_token is an RFC 2119 MUST requirement (#1846) 
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
 2024-06-07 08:34:34 +00:00
Kévin Commaille 1e303b3bbc
Do not require UIA when first uploading cross-signing keys (#1828) 
As per MSC3967.
 2024-06-06 11:06:32 +01:00
Matthias Ahouansou 7ff785fc38
Clarify that the event field of the send_join is only required when performing a restricted join (#1834) 2024-06-03 14:09:40 +01:00
Kévin Commaille 3674985dd6
Factor out the common definitions of the content repo APIs and add new formats (#1822) 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2024-05-28 15:38:39 +01:00
Kévin Commaille b0df8e7fb5
Use patternProperties in more places with supported formats (#1813) 
Allows to have more places where the property name's type is better defined.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2024-05-08 13:59:17 +00:00
Richard van der Hoff df1e799c51
Spec terms of service at registration (MSC1692) (#1812) 
Spec for matrix-org/matrix-spec-proposals#1692

Co-authored-by: Hubert Chathi <hubertc@matrix.org>
 2024-05-08 13:51:18 +00:00
Kévin Commaille 98d85cf421
Add support for rendering string formats (#1814) 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2024-05-07 20:50:36 -04:00
Richard van der Hoff 48f4c4954f
Include information about additionalProperties in object tables (#1798) 
Currently, if we have an object which has additionalProperties in addition to properties, that information gets lost. This PR seeks to address that.
 2024-05-02 11:10:16 +01:00
Matthias Ahouansou eea3dfa969
Mention notifying AS for sender_localpart events (#1810) 
Signed-off-by: Matthias Ahouansou <matthias@ahouansou.cz>
 2024-05-01 10:48:11 +01:00
Kévin Commaille 2d18aac201
Use OneTimeKeys schema (#1800) 
This was commented prior to the
port to OpenAPI 3.1 for technical reasons (#1127).
Now we can use it just fine.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2024-04-30 18:13:05 +01:00
Kévin Commaille 625999a039
Deprecate authentication via a query string (#1808) 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2024-04-30 17:07:59 +01:00
Kévin Commaille 2edfb21d5d
Add support for pattern formats for patternProperties (#1796) 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2024-04-24 12:42:34 +01:00
Kévin Commaille 26ce3929b4
Clean up unecessary allOfs (#1797) 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2024-04-23 17:07:24 +01:00
Richard van der Hoff 2b5f990f60
Factor out common definition of Tag type (#1793) 
... and remove spurious `additionalProperties: true`
 2024-04-17 13:51:24 +01:00
Richard van der Hoff 073ce659df
Define opaque identifier grammar (#1791) 
Since we already have three of these, and I'm about to add a fourth, let's pull
it out to a common definition.

We could, of course, keep defining the grammar each time it's used, but
defining it in an appendix helps us be consistent for future API design.
 2024-04-17 09:22:06 +01:00
Kévin Commaille 2ea8e0f514
Remove enum for POST /login type definition (#1776) 
Since the enum is not exhaustive, improve the description of the property instead.
 2024-04-09 17:27:26 +01:00
Kévin Commaille efe72d3b26
Fix security schemes in OpenAPI definitions (#1772) 2024-04-09 18:12:30 +02:00