Commit graph

224 commits

Author SHA1 Message Date
Johannes Marbach fc81171081
Clarify the meaning of "public rooms" for user directory queries (#2102) 2025-05-13 14:37:31 +01:00
Kim Brose ca9c376076
Clarify Well-Known URIs (#2140)
Some checks failed
Spec / 🔎 Validate OpenAPI specifications (push) Has been cancelled
Spec / 🔎 Check Event schema examples (push) Has been cancelled
Spec / 🔎 Check OpenAPI definitions examples (push) Has been cancelled
Spec / 🔎 Check JSON Schemas inline examples (push) Has been cancelled
Spec / ⚙️ Calculate baseURL for later jobs (push) Has been cancelled
Spec / 📢 Run towncrier for changelog (push) Has been cancelled
Spell Check / Spell Check with Typos (push) Has been cancelled
Spec / 🐍 Build OpenAPI definitions (push) Has been cancelled
Spec / 📖 Build the spec (push) Has been cancelled
Spec / 🔎 Validate generated HTML (push) Has been cancelled
Spec / 📖 Build the historical backup spec (push) Has been cancelled
* 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-05-08 13:55:51 +02:00
Kévin Commaille fca171427f
Clarifications around third-party invites (#2083)
Some checks failed
Spec / 🔎 Validate OpenAPI specifications (push) Has been cancelled
Spec / 🔎 Check Event schema examples (push) Has been cancelled
Spec / 🔎 Check OpenAPI definitions examples (push) Has been cancelled
Spec / 🔎 Check JSON Schemas inline examples (push) Has been cancelled
Spec / ⚙️ Calculate baseURL for later jobs (push) Has been cancelled
Spec / 📢 Run towncrier for changelog (push) Has been cancelled
Spell Check / Spell Check with Typos (push) Has been cancelled
Spec / 🐍 Build OpenAPI definitions (push) Has been cancelled
Spec / 📖 Build the spec (push) Has been cancelled
Spec / 🔎 Validate generated HTML (push) Has been cancelled
Spec / 📖 Build the historical backup spec (push) Has been cancelled
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2025-04-22 15:48:50 +01:00
Kévin Commaille c39c7d0680
Fix /sync example (#2077)
Some checks are pending
Spec / 🔎 Validate OpenAPI specifications (push) Waiting to run
Spec / 🔎 Check Event schema examples (push) Waiting to run
Spec / 🔎 Check OpenAPI definitions examples (push) Waiting to run
Spec / 🔎 Check JSON Schemas inline examples (push) Waiting to run
Spec / ⚙️ Calculate baseURL for later jobs (push) Waiting to run
Spec / 🐍 Build OpenAPI definitions (push) Blocked by required conditions
Spec / 📢 Run towncrier for changelog (push) Waiting to run
Spec / 📖 Build the spec (push) Blocked by required conditions
Spec / 🔎 Validate generated HTML (push) Blocked by required conditions
Spec / 📖 Build the historical backup spec (push) Blocked by required conditions
Spell Check / Spell Check with Typos (push) Waiting to run
* Fix sync example

The same event should not appear in `state` and in the `timeline` so we cannot use the same event twice.

To provide a `state` example we assume that with lazy-loading the user did not get the state event for `@example:example.org`, so we add one since they sent a message in the timeline.

The events that are referenced include a `room_id`, which doesn't appear on this endpoint, so we copy them without it.

Finally, the `join` event of `@alice:example.org` is wrong because the sender does not match the state key, which wouldn't pass the authorization rules.

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

* Fix the `m.room.member.yaml` example

This is a `join` event, and the `sender` doesn't match the `state_key`, so the event couldn't pass the authorization rules.

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-04-15 14:47:21 +01:00
Johannes Marbach c7581356bf
MSC4260: Reporting users (Client-Server API) (#2093)
Some checks failed
Spec / 🔎 Validate OpenAPI specifications (push) Has been cancelled
Spec / 🔎 Check Event schema examples (push) Has been cancelled
Spec / 🔎 Check OpenAPI definitions examples (push) Has been cancelled
Spec / 🔎 Check JSON Schemas inline examples (push) Has been cancelled
Spec / ⚙️ Calculate baseURL for later jobs (push) Has been cancelled
Spec / 📢 Run towncrier for changelog (push) Has been cancelled
Spell Check / Spell Check with Typos (push) Has been cancelled
Spec / 🐍 Build OpenAPI definitions (push) Has been cancelled
Spec / 📖 Build the spec (push) Has been cancelled
Spec / 🔎 Validate generated HTML (push) Has been cancelled
Spec / 📖 Build the historical backup spec (push) Has been cancelled
* 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-03-21 13:33:26 -06: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
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 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
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
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
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
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 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 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
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 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
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
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
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