Commit graph

286 commits

Author SHA1 Message Date
Kévin Commaille 30b68df0ce Reorganize client authentication section to separate the legacy API and the new OAuth 2.0 API (#2141)
Since account locking and suspension are authentication API agnostic,
this is a pre-requisite to adding the new OAuth 2.0-based API.

This also splits the endpoints that where all included in the
registration OpenAPI data, to separate them cleanly in the spec, and
avoid having deactivation show before registration.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2025-07-30 11:58:25 +01:00
Johannes Marbach 59fdc01d6a Clarify the meaning of "public spaces" (#2109)
Relates to: #633

Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2025-07-30 11:58:25 +01:00
Johannes Marbach 6ce859cd7f Spec PR - MSC4147: Including device keys with Olm-encrypted events (#2122)
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
Co-authored-by: Richard van der Hoff <richard@matrix.org>
2025-07-30 11:58:25 +01:00
Johannes Marbach 153d6d90d4 Clarify the meaning of "public rooms" in the room directory (#2104)
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
Co-authored-by: Kim Brose <2803622+HarHarLinks@users.noreply.github.com>
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2025-07-30 11:58:25 +01:00
Andy Balaam ffc744805d Fix typo: as->has (#2144)
Signed-off-by: Andy Balaam <andy.balaam@matrix.org>
2025-07-30 11:58:25 +01:00
Johannes Marbach 65702c7f6c Spec PR - MSC3765: Rich text in room topics (#2095)
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2025-07-30 11:58:25 +01:00
Johannes Marbach 40f7d1006b Clarify the meaning of "public rooms" for presence (#2108) 2025-07-30 11:58:25 +01:00
Johannes Marbach 8e4b0df51c Clarify the meaning of "public rooms" for policy lists (#2107) 2025-07-30 11:58:25 +01:00
Johannes Marbach 9cf45d4976 Clarify the meaning of "public rooms" for call invites (#2106) 2025-07-30 11:58:25 +01:00
Johannes Marbach 9930c122ee Clarify the meaning of "public rooms" for profile look-ups (#2101) 2025-07-30 11:58:25 +01:00
Kim Brose 5f083d229f Clarify Well-Known URIs (#2140)
* Clarify Well-Known URIs

Signed-off-by: HarHarLinks <2803622+HarHarLinks@users.noreply.github.com>

* Fix section link

---------

Signed-off-by: HarHarLinks <2803622+HarHarLinks@users.noreply.github.com>
2025-07-30 11:58:25 +01:00
Kévin Commaille 9dacac832d Clarifications around third-party invites (#2083)
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2025-07-30 11:58:25 +01:00
Andy Balaam e584e7f811 Typo "not" -> "no" (#2121)
* Typo "not" -> "no"

Signed-off-by: Andy Balaam <andy.balaam@matrix.org>

---------

Signed-off-by: Andy Balaam <andy.balaam@matrix.org>
2025-07-30 11:58:25 +01:00
Johannes Marbach cd2c3968cb MSC4260: Reporting users (Client-Server API) (#2093)
* MSC4260: Reporting users (Client-Server API)

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

* Add changelog

* Update data/api/client-server/report_content.yaml

Co-authored-by: Kévin Commaille <76261501+zecakeh@users.noreply.github.com>

* Move option to consistently respond with 200 to user reporting endpoint

* Move optional random delay to event and user reporting endpoints

* Make reason required for user and room reports

* Fix requiredness syntax

---------

Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
Co-authored-by: Kévin Commaille <76261501+zecakeh@users.noreply.github.com>
2025-07-30 11:58:25 +01:00
Johannes Marbach 88f3529756 Clients can choose which history visibility options they offer to users when creating rooms (#2072)
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2025-07-30 11:58:25 +01:00
Patrick Cloke 6646146f8c
Accept minor suggestions from code review
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2025-06-13 10:26:20 -04:00
Tom Foster 17af55ddce Fix broken link 2025-02-14 13:30:33 +00:00
Johannes Marbach ad17652fce
Clarify that applying redactions is a SHOULD for clients (#2055) 2025-01-15 10:07:37 +00:00
Johannes Marbach b9f46d1d85
Add missing preposition (#2048)
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2025-01-14 18:52:10 +00:00
morguldir e341525e04
Undeprecate /initialSync for peeking (#2036)
Signed-off-by: morguldir <morguldir@protonmail.com>
2025-01-14 18:50:30 +00:00
Travis Ralston 2fd5bf10bb
Specify account suspension (#2014)
* Specify account suspension

* changelog

* Apply suggestions from code review

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>

* Add some links

---------

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2024-12-11 18:12:26 -07:00
Kévin Commaille 846cc49eb2
Clarify allowed HTTP methods in CORS responses (take 2) (#2011)
* Clarify allowed HTTP methods in CORS responses (take 2)

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

* Update previous changelog an add duplicate changelog

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

---------

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2024-12-11 10:21:49 -07: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 075a98d619
Add hyperlinks to endpoints (#2016)
... because there's nothing more infuriating than someone talking about an
endpoint, then having to search through 150 pages of spec for it.
2024-12-09 11:03:53 +00:00
Kévin Commaille 8ab2988824
Remove reply fallbacks (#1994)
As per MSC2781.
2024-11-29 09:44:07 +00:00
Kévin Commaille f64eec5a93
Use json instead of json5 for syntax highlighting (#2017)
* Use json instead of json5 for syntax highlighting

Chroma, the library used for syntax highlighting in Hugo, does not support JSON5 so those code blocks were not highlighted.
However it supports comments in JSON so they are highlighted correctly in the rendered spec.

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-11-28 15:49:35 +01: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 9882d95775
Improve the quality of the rendered diagrams (#1999)
The first commit allows to lazy-load the diagrams, which should improve the loading time of the CS API on mobile. In the process it also improves the alt text of the images.

The second commit serves the diagrams as high-resolution WebPs. Encoding a high resolution diagram as WebP gives a file of approximately the same size as the lower resolution PNG. For maximum compatibility we also serve them as a lower resolution WebP and a fallback PNG. WebP was chosen because it is one of the export formats of draw.io/diagrams.net, and it is widely available in modern browsers.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2024-11-19 21:41:45 +00:00
Kévin Commaille c5d7eb7a2d
Add PATCH and HEAD to the allowed HTTP methods in CORS responses (#1995) 2024-11-14 11:51:06 +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
Kévin Commaille 1e47d7ec48
Remove boxes/added-in-paragraph shortcode (#1970) 2024-10-14 17:57:33 +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
Travis Ralston 9486237f1b
Allow guests to access media (MSC4189) (#1959)
MSC: https://github.com/matrix-org/matrix-spec-proposals/pull/4189
2024-09-30 11:36:17 -06:00
Johannes Marbach ace2712719
MSC3939: Account locking (#1934) 2024-09-26 14:19:45 +01:00
Kévin Commaille 6d088e03a1
Add added-in shortcode for unread markers section (#1941)
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2024-09-04 08:53:06 -04: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
Kim Brose c6d974975e
Improve wording of the unauthenticated media deprecation box (#1916) 2024-08-14 17:36:33 +01:00
Johannes Marbach d9c447e194
Document m.get_login_token capability (#1908) 2024-07-19 11:13:10 +01:00
Matthias Ahouansou 149d5d2a95
remove confusing description of restricted rooms with no valid conditions (#1903) 2024-07-17 14:26:28 +00: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 b1349dd06f
Remove the deprecated name attribute on HTML anchor elements (#1870)
* Remove the deprecated name attribute on HTML anchor elements

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

* Add changelog

* Update content/client-server-api/modules/instant_messaging.md

Co-authored-by: Travis Ralston <travpc@gmail.com>

* Update content/client-server-api/modules/instant_messaging.md

Co-authored-by: Travis Ralston <travpc@gmail.com>

* Update changelogs/client_server/newsfragments/1870.deprecation

* Rename 1870.deprecation to 1870.removal

---------

Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
Co-authored-by: Travis Ralston <travpc@gmail.com>
Co-authored-by: Hubert Chathi <hubertc@matrix.org>
2024-07-09 23:44:26 -04:00
Johannes Marbach e4589bbc8a
Clarify that dont_notify and coalesce MUST be gracefully ignored (#1890) 2024-07-09 21:35:57 -04:00
Johannes Marbach 5abc31111f
Clarify arguments of window.matrixLogin.onLogin (#1905) 2024-07-08 07:51:27 -04:00
Johannes Marbach e53e6ea876
Fix callback function for fallback login (#1899) 2024-07-05 06:54:42 -04:00
davidegirardi 7d94efe136
Spell out secure secret storage and sharing (#1875)
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
Co-authored-by: Travis Ralston <travpc@gmail.com>
2024-07-03 15:00:01 +01:00
Johannes Marbach d7299b5a32
Rename and sort the modules in the feature profiles table for easier skimming (#1855)
* Rename modules to match section titles.

* Sort the table by requiredness, then alphabetically by module name.
2024-06-26 11:53:28 -04:00
Johannes Marbach 7eda6ad299
Improve recommendation for how to form transaction IDs (#1888)
Fixes: #1706
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2024-06-25 15:55:46 +01:00
Kévin Commaille 18628dc5d7
Allow to specify a prefix for generated HTML IDs of API endpoints (#1882)
* Allow to specify a prefix for generated HTML IDs of API endpoints

Allows to deduplicate IDs of duplicate endpoints

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 15:39:50 +00:00