matrix-spec/data/api/client-server
Travis Ralston f97d2944ae
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
Room version 12 (#2193)
* Placeholder

* i++

* Room version 12

Template out a v12 room version

Make v12 default, per MSC4304

Update PDU checks and auth event selection per MSC4291

Describe new room_id format per MSC4291

Move v6 depth definition to a component for easier referencing

Move room_id to a component to prep for v12, per MSC4291

Create and use a new room_id component for v12+ per MSC4291

Reflect auth events selection change onto all room versions per MSC4291

The MSC asks the `description` of `auth_events` to be adjusted, however this feels like a better representation of the change.

Add `room_id` format rules and renumber per MSC4291

Reflect change to rule 1.2 per MSC4291

Insert same room_id check to v1-12 auth rules per MSC4307 and MSC4291

Deprecate `predecessor.event_id` per MSC4291

Insert auth rule to validate `additional_creators` per MSC4289

Insert rule for `users` validation of creators and renumber per MSC4289

Define "room creator(s)" per MSC4289

Spec `additional_creators` on create events per MSC4289

Spec `additional_creators` on `/upgrade` per MSC4289

The MSC doesn't mention how to handle unsupported room versions, but the Synapse implementation used for FCP ignores the field in such room versions. This feels like a good approach, and will need clarifying in the MSC too (if accepted at the spec level).

Add notes to `/upgrade` behaviour per MSC4289 and MSC4291

Describe how additional creators work during room creation per MSC4289

Fix default user power level descriptions per MSC4289

Describe tombstone power level changes per MSC4289

Warn clients about event format changes in v12 per MSC4289 and MSC4291

Flag additional room creators support for client reference per MSC4289

Remove TODO now that it's fully addressed

Copy state res into v12 as-is for modification

Apply Modification 1 to SR2.1 per MSC4297

Apply Modification 2 to SR2.1 per MSC4297

Add summary box to the top of SR2.1 for ease of developer reference

Modification 2 was split into items 2 and 3 for further ease of understanding.

Add all the changelogs

`x` is used until a real PR number can be assigned.

Some changelogs are duplicated to the Client-Server API to increase visibility of the changes to v12.

Review: Minor phrasing adjustments in changelogs

Review: Clarify that v12 isn't quite the default yet in the changelog

Review: Clarify to clients that creators are immutable

Review: Improve 'how to parse a domain' advice for legacy apps

Review: Add a bit more detail as to why a room ID might be required

Apply suggestions from code review

Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>

Clarify that clients can override the tombstone default

Mention creatorship UI label by finishing the Permissions section

We probably should have removed the WIP note in v1.0, but alas.

Add changelog for tombstone changes

Use assigned spec PR number in changelogs

(cherry picked from commit ec81eea7e4532fd398b8013071d6981c97117d9e)
2025-08-14 11:16:00 -06:00
..
definitions Fix new redocly lints (#2182) 2025-07-29 17:22:26 +00:00
account-data.yaml Fix relative URLs when serving the specification with a custom baseURL (#1984) 2024-11-14 11:11:34 +00:00
account_deactivation.yaml Reorganize client authentication section to separate the legacy API and the new OAuth 2.0 API (#2141) 2025-06-03 19:05:24 +01:00
admin.yaml Fix security schemes in OpenAPI definitions (#1772) 2024-04-09 18:12:30 +02:00
administrative_contact.yaml Final tweaks for the OAuth 2.0 API (#2164) 2025-06-26 10:40:43 -06:00
appservice_ping.yaml Fix relative URLs when serving the specification with a custom baseURL (#1984) 2024-11-14 11:11:34 +00:00
appservice_room_directory.yaml Clarify the meaning of "public rooms" in the room directory (#2104) 2025-05-21 16:43:02 +01:00
authed-content-repo.yaml Specify Content-Type and Content-Disposition usage in the media repo (#1935) 2024-09-02 10:41:33 +02:00
banning.yaml Fix security schemes in OpenAPI definitions (#1772) 2024-04-09 18:12:30 +02:00
capabilities.yaml Spec for MSC4133: Update profile endpoints to support extended fields (#2071) 2025-08-12 12:17:57 +01:00
content-repo.yaml Clarify that the async upload endpoint will return 404 in some cases (#1983) 2024-11-06 11:28:47 +00:00
create_room.yaml Room version 12 (#2193) 2025-08-14 11:16:00 -06:00
cross_signing.yaml Final tweaks for the OAuth 2.0 API (#2164) 2025-06-26 10:40:43 -06:00
device_management.yaml Final tweaks for the OAuth 2.0 API (#2164) 2025-06-26 10:40:43 -06:00
directory.yaml Fix security schemes in OpenAPI definitions (#1772) 2024-04-09 18:12:30 +02:00
event_context.yaml Fix security schemes in OpenAPI definitions (#1772) 2024-04-09 18:12:30 +02:00
filter.yaml Clean up unecessary allOfs (#1797) 2024-04-23 17:07:24 +01:00
inviting.yaml Fix security schemes in OpenAPI definitions (#1772) 2024-04-09 18:12:30 +02:00
joining.yaml MSC4213: Remove server_name parameter (#2059) 2025-02-11 18:03:25 +00:00
key_backup.yaml Deduplicate RoomKeysUpdateResponse (#2073) 2025-03-05 09:52:40 +00:00
keys.yaml Specify the order in which one-time keys are returned (MSC4225) (#2029) 2024-12-12 15:53:21 +00:00
kicking.yaml Fix security schemes in OpenAPI definitions (#1772) 2024-04-09 18:12:30 +02:00
knocking.yaml MSC4213: Remove server_name parameter (#2059) 2025-02-11 18:03:25 +00:00
leaving.yaml Fix security schemes in OpenAPI definitions (#1772) 2024-04-09 18:12:30 +02:00
list_joined_rooms.yaml Fix security schemes in OpenAPI definitions (#1772) 2024-04-09 18:12:30 +02:00
list_public_rooms.yaml Clarify the meaning of "public rooms" in the room directory (#2104) 2025-05-21 16:43:02 +01:00
login.yaml Clarify formats of string types for the POST /_matrix/client/v3/login endpoint (#1980) 2024-11-06 11:14:24 +00:00
login_token.yaml Document m.get_login_token capability (#1908) 2024-07-19 11:13:10 +01:00
logout.yaml Fix typo (#2177) 2025-07-14 14:09:08 +03:00
message_pagination.yaml Fix security schemes in OpenAPI definitions (#1772) 2024-04-09 18:12:30 +02:00
notifications.yaml Fix security schemes in OpenAPI definitions (#1772) 2024-04-09 18:12:30 +02:00
oauth_server_metadata.yaml Add the OAuth 2.0 server metadata discovery endpoint (#2147) 2025-06-17 17:47:30 +01:00
old_sync.yaml Remove extra trailing quotes from sync API specs (#2091) 2025-03-05 09:12:15 -05:00
openid.yaml Fix security schemes in OpenAPI definitions (#1772) 2024-04-09 18:12:30 +02:00
password_management.yaml Reorganize client authentication section to separate the legacy API and the new OAuth 2.0 API (#2141) 2025-06-03 19:05:24 +01:00
peeking_events.yaml Fix security schemes in OpenAPI definitions (#1772) 2024-04-09 18:12:30 +02:00
presence.yaml Fix security schemes in OpenAPI definitions (#1772) 2024-04-09 18:12:30 +02:00
profile.yaml Spec for MSC4133: Update profile endpoints to support extended fields (#2071) 2025-08-12 12:17:57 +01:00
pusher.yaml Clarify that servers must forward custom keys in PusherData (#1973) 2024-10-30 10:33:44 +00:00
pushrules.yaml Remove references to device-specific push rules. (#1842) 2024-08-01 10:33:41 -04:00
read_markers.yaml Fix security schemes in OpenAPI definitions (#1772) 2024-04-09 18:12:30 +02:00
receipts.yaml Fix security schemes in OpenAPI definitions (#1772) 2024-04-09 18:12:30 +02:00
redaction.yaml Fix typo in /_matrix/client/v3/rooms/{roomId}/redact/{eventId}/{txnId} (#2047) 2025-01-14 18:52:56 +00:00
refresh.yaml Upgrade Swagger data to OpenAPI 3.1 (#1310) 2023-06-07 13:16:29 +01:00
registration.yaml Reorganize client authentication section to separate the legacy API and the new OAuth 2.0 API (#2141) 2025-06-03 19:05:24 +01:00
registration_tokens.yaml Upgrade Swagger data to OpenAPI 3.1 (#1310) 2023-06-07 13:16:29 +01:00
relations.yaml Clarify that relations recursion should be capped at a certain depth (#1854) 2024-06-13 14:34:54 -04:00
report_content.yaml MSC4260: Reporting users (Client-Server API) (#2093) 2025-03-21 13:33:26 -06:00
room_event_by_timestamp.yaml Fix relative URLs when serving the specification with a custom baseURL (#1984) 2024-11-14 11:11:34 +00:00
room_initial_sync.yaml Remove extra trailing quotes from sync API specs (#2091) 2025-03-05 09:12:15 -05:00
room_send.yaml Fix security schemes in OpenAPI definitions (#1772) 2024-04-09 18:12:30 +02:00
room_state.yaml Fix security schemes in OpenAPI definitions (#1772) 2024-04-09 18:12:30 +02:00
room_summary.yaml Fix new redocly lints (#2182) 2025-07-29 17:22:26 +00:00
room_upgrades.yaml Room version 12 (#2193) 2025-08-14 11:16:00 -06:00
rooms.yaml Add format query parameter to GET /state/{eventType}/{stateKey} (#2175) 2025-07-19 22:52:41 +03:00
search.yaml Use patternProperties in more places with supported formats (#1813) 2024-05-08 13:59:17 +00:00
space_hierarchy.yaml Spec PR - MSC3266: Room Summary API (#2125) 2025-06-04 07:43:06 -04:00
sso_login_redirect.yaml Upgrade Swagger data to OpenAPI 3.1 (#1310) 2023-06-07 13:16:29 +01:00
support.yaml Clarify Well-Known URIs (#2140) 2025-05-08 13:55:51 +02:00
sync.yaml Add state_after to /sync (#2187) 2025-08-06 15:49:32 -04:00
tags.yaml Factor out common definition of Tag type (#1793) 2024-04-17 13:51:24 +01:00
third_party_lookup.yaml Document instance_id field of /thirdparty/protocols (#2051) 2025-02-13 17:29:56 +00:00
third_party_membership.yaml Clarifications around third-party invites (#2083) 2025-04-22 15:48:50 +01:00
threads_list.yaml Fix security schemes in OpenAPI definitions (#1772) 2024-04-09 18:12:30 +02:00
to_device.yaml Use patternProperties in more places with supported formats (#1813) 2024-05-08 13:59:17 +00:00
typing.yaml Fix security schemes in OpenAPI definitions (#1772) 2024-04-09 18:12:30 +02:00
users.yaml Clarify the meaning of "public rooms" for user directory queries (#2102) 2025-05-13 14:37:31 +01:00
versions.yaml Fix security schemes in OpenAPI definitions (#1772) 2024-04-09 18:12:30 +02:00
voip.yaml Fix security schemes in OpenAPI definitions (#1772) 2024-04-09 18:12:30 +02:00
wellknown.yaml Clarify Well-Known URIs (#2140) 2025-05-08 13:55:51 +02:00
whoami.yaml Clarify formats of string types in account sections (#2046) 2025-01-17 17:18:51 +00:00