Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-02-18 12:03:42 +01:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
6895 commits 28 branches 42 tags 34 MiB
Commit graph

352 commits

Author SHA1 Message Date
Kévin Commaille 05afa1bdbf
Merge 827ee5f880 into 7fd49a2808 2025-03-21 16:05:43 +00:00
Johannes Marbach e283c35dbd
Remove extra trailing quotes from sync API specs (#2091) 
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
 2025-03-05 09:12:15 -05:00
Kévin Commaille 1916e53f8c
Deduplicate Invite3pid (#2074) 
* Deduplicate Invite3pid

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2025-03-05 09:56:49 +00:00
Kévin Commaille 02a1aeefbc
Deduplicate RoomKeysUpdateResponse (#2073) 
And add a link to the endpoint that is mentionned while we're at it.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2025-03-05 09:52:40 +00:00
Kévin Commaille 3adbfa30da
Look for examples in all possible locations (#2076) 
We used to only look for examples in a few (sometimes arbitrary) places, and we didn't support showing several examples in most cases. This is intended to fix this. In the process we try to deduplicate code to make sure that we use the same logic everywhere.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2025-03-05 09:44:59 +00:00
Kévin Commaille 60339adb2d
Refactor PDU definitions to reduce duplication (#2070) 
First of all, all PDU definitions were based on the v1 PDU definition with a few fields overwritten to change the format with needed.
While that works when rendering the spec, this is semantically incorrect because it means that the objects must match both schemas, which is impossible.

So now we make a base with only the common fields, and we add the others as needed by the room version.
Note that there is no more "unsigned PDU" definition since it is not used directly, and hashes and signatures are the same across all versions.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2025-03-04 17:08:42 +00:00
Hubert Chathi ae06f37470
fix typos in m.room_key.withheld (#2080) 
* fix typos

* add changelog
 2025-02-25 17:11:50 -05:00
Kévin Commaille 39ee16cbf2
Fix typo 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2025-02-22 20:19:03 +01:00
Kévin Commaille 9c28036488
Clarify base64 encoding of IS API key management endpoints 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2025-02-22 19:58:31 +01:00
Kévin Commaille 295b94ad37
Clarify string formats and base64 encoding of /store-invite endpoint 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2025-02-22 19:54:10 +01:00
Kévin Commaille 0f8508dbf7
Clarify formats of SS API third-party invite endpoints 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2025-02-22 19:46:59 +01:00
Kévin Commaille d501212025
Deduplicate signed property of third party invite 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2025-02-22 19:37:07 +01:00
Kévin Commaille 1f995a0e78
Add link to m.room.third_party_invite definition 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2025-02-22 17:40:51 +01:00
Kévin Commaille b9724c6ae0
Fix formatting of m.room.member schema 
Wrap lines at around 100 characters

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2025-02-22 17:38:51 +01:00
Kévin Commaille 0e4c773beb
Clarify and fix formatting of third-party /invite endpoint 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2025-02-22 17:19:34 +01:00
Kévin Commaille 15beaff95e
Remove redundant sentence in third-party /invite endpoint description 
The exact same thing is said two paragraphs before.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2025-02-22 17:16:19 +01:00
Kévin Commaille c21b914404
Clarify that public keys in m.room.third_party_event is encoded using standard or URL-safe base64. 
Sydent has been using both alphabets.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2025-02-22 17:13:03 +01:00
Kévin Commaille f793658de5
Fix formatting of m.room.third_party_invite schema 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2025-02-22 17:03:19 +01: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
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