Tom Foster
0a87d1b0a1
Update data/api/client-server/profile.yaml
...
Co-authored-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2025-07-31 14:10:07 +01:00
Tom Foster
3da3b18779
Update data/api/client-server/profile.yaml
...
Co-authored-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2025-07-31 14:10:00 +01:00
Tom Foster
6a8b542d2c
Update data/api/client-server/profile.yaml
...
Co-authored-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2025-07-31 14:09:53 +01:00
Tom Foster
22a3405547
Update data/api/client-server/capabilities.yaml
...
Co-authored-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2025-07-31 14:09:45 +01:00
Tom Foster
3f5c14b679
Update data/api/client-server/capabilities.yaml
...
Co-authored-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2025-07-31 14:09:33 +01:00
Tom Foster
9357cea9ce
Update data/api/client-server/capabilities.yaml
...
Co-authored-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2025-07-31 14:09:18 +01:00
Tom Foster
48ee9cf59c
Update data/api/client-server/profile.yaml
...
Co-authored-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2025-07-31 14:09:03 +01:00
Tom Foster
648c05002a
Update data/api/client-server/profile.yaml
...
Co-authored-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2025-07-31 14:08:41 +01:00
Tom Foster
b834933171
Update data/api/client-server/profile.yaml
...
Co-authored-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2025-07-31 14:08:24 +01:00
Tom Foster
5a082635f7
Update data/api/client-server/profile.yaml
...
Co-authored-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2025-07-31 14:08:13 +01:00
Tom Foster
569c8aafa3
Merge upstream main into MSC4133
2025-07-31 11:25:13 +01:00
Kévin Commaille
7d2de48cb4
Fix new redocly lints ( #2182 )
...
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>
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2025-07-29 17:22:26 +00:00
Tulir Asokan
c8380d9552
Add format query parameter to GET /state/{eventType}/{stateKey} ( #2175 )
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
2025-07-19 22:52:41 +03:00
Johannes Marbach
0e280ed014
Fix typo ( #2177 )
...
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
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2025-07-14 14:09:08 +03:00
Kévin Commaille
1c06ed9cf7
Final tweaks for the OAuth 2.0 API ( #2164 )
...
* Clarify that SSO login applies to the legacy authentication API
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
* Do not point to specific authentication API for obtaining access token
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
* Add warnings about incompatibility with OAuth 2.0 to endpoints that use UIA
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
* Add changelog
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
* Add note about API standards not applying to OAuth 2.0
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
* Apply suggestions from code review
---------
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
Co-authored-by: Travis Ralston <travpc@gmail.com>
2025-06-26 10:40:43 -06:00
Richard van der Hoff
979264e923
Fix example for ExportedSessionData ( #2154 )
...
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
Currently, the example for `ExportedSessionData` is missing values for
`room_id` and `session_id`.
Move the example field values for `KeyBackupSessionData` into the field
definitions, so that an example for the object as a whole is built
automatically, and when we extend it to form `ExportedSessionData` the
explicit example does not override the more complete autogenerated one.
2025-06-17 18:43:40 +01:00
Kévin Commaille
51ccbbd240
Add the OAuth 2.0 server metadata discovery endpoint ( #2147 )
...
As per MSC2965.
2025-06-17 17:47:30 +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
Kévin Commaille
32b1f0514d
Clarify some string formats of room summary endpoint ( #2158 )
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
2025-06-07 15:26:56 +02:00
Johannes Marbach
7bcc3ecb81
Spec PR - MSC3266: Room Summary API ( #2125 )
...
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: Johannes Marbach <n0-0ne+github@mailbox.org>
2025-06-04 07:43:06 -04:00
Kévin Commaille
866c05f487
Reorganize client authentication section to separate the legacy API and the new OAuth 2.0 API ( #2141 )
...
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
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-06-03 19:05:24 +01:00
Johannes Marbach
643a6dca2d
Spec PR - MSC4147: Including device keys with Olm-encrypted events ( #2122 )
...
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: Johannes Marbach <n0-0ne+github@mailbox.org>
Co-authored-by: Richard van der Hoff <richard@matrix.org>
2025-05-28 18:50:27 +01:00
Johannes Marbach
2c734c3c5b
Clarify the meaning of "public rooms" in the room directory ( #2104 )
...
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: 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-05-21 16:43:02 +01:00
Johannes Marbach
0439707624
Spec PR - MSC3765: Rich text in room topics ( #2095 )
...
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2025-05-13 16:01:25 +01:00
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 )
...
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 )
...
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 )
...
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 )
...
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
Tom Foster
6183f2410f
Clarify value validation requirements
2025-02-21 10:32:28 +00:00
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