Tom Foster
2d3f1710d3
Merge 6183f2410f into 81273df88e
2025-04-18 09:54:25 +01:00
Kévin Commaille
81273df88e
Adjust margins in rendered endpoints ( #2081 )
...
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
* Use consistent spacing between tables and code blocks
Tables used `4 rem` which is more than the margin above a h2 title, which seems excessive. We change it to `2 rem` which matches the margin of code blocks and info boxes.
We also remove the margin on the last item of a `.rendered-data` block because this is just wasted space.
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
* Adjust spacing around h2 and h3 titles in `.rendered-data`
Given that h2 titles are always preceded by an horizontal rule, we don't need a lot of space to separate them from the previous section.
We also reduce the spacing when a h2 title is followed directly by a h3 title.
Finally, we add a little spacing below both so that tables are less close to the title.
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>
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2025-04-15 18:35:27 +01:00
Will Hunt
65b1db721d
Describe behaviour when the topic key is falsey in a m.room.topic event. ( #2068 )
...
We seem to have [updated this for m.room.name](https://github.com/matrix-org/matrix-spec/pull/1639 ) some years back but omitted it for topic.
2025-04-15 18:24:22 +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
Travis Ralston
23ff7f1343
Fix minor typo in content hash calculations ( #2128 )
...
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
* Fix minor typo in content hash calculations
* Changelog
2025-04-07 14:28:00 -06:00
Andy Balaam
8a2c58b1b1
Typo "not" -> "no" ( #2121 )
...
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
* Typo "not" -> "no"
Signed-off-by: Andy Balaam <andy.balaam@matrix.org>
---------
Signed-off-by: Andy Balaam <andy.balaam@matrix.org>
2025-03-28 14:13:17 +00:00
Kim Brose
817ec5380f
Create funding-manifest-urls ( #2115 )
...
* Create funding-manifest-urls
* update funding-manifest-urls location, add news
Signed-off-by: HarHarLinks <2803622+HarHarLinks@users.noreply.github.com>
---------
Signed-off-by: HarHarLinks <2803622+HarHarLinks@users.noreply.github.com>
2025-03-28 13:19:23 +00:00
Travis Ralston
029be205b9
-> unstable
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
2025-03-27 10:30:02 -06:00
Travis Ralston
fe880fdaf4
v1.14
2025-03-27 10:28:55 -06:00
Travis Ralston
71ce620fc0
Add a v6 event format with correct depth limits ( #2114 )
...
* Add a v6 event format with correct `depth` limits
* Changelog
* numbers are hard
2025-03-27 10:23:09 -06:00
Travis Ralston
cb6d039c57
Normalize changelog
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-03-25 15:40:04 -06: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
Kévin Commaille
7fd49a2808
Set room version 11 as the default ( #2105 )
...
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
* Set room version 11 as the default
As per MSC4239
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-03-20 12:00:33 -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
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
4ff9a851e6
Add link to git commit for unstable changelog too ( #2078 )
...
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2025-03-05 09:43:27 +00:00
Johannes Marbach
844dd6f8ae
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-03-04 17:18:27 +00:00
Kévin Commaille
dfc61ffc71
Fix parsing of nested slices in resolve-refs and resolve-allof partials ( #2069 )
...
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2025-03-04 17:14:42 +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
10587366e9
For room versions 6 and 7, clarify that events with rejected auth eve… ( #2065 )
...
Other room versions were updated in #1103 and #1137 , but not these ones.
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2025-02-25 21:00:32 +00:00
Kévin Commaille
eedecf863a
Clarify that join rules must be in auth events for knock events ( #2063 )
...
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2025-02-25 20:34:23 +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
7a3b0c0804
Clarify in change log that m.set_avatar_url and m.set_displayname capabilities are now deprecated
2025-02-14 15:03:17 +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
17af55ddce
Fix broken link
2025-02-14 13:30:33 +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
Tom Foster
f3c269d951
Added capability
2025-02-14 12:20:25 +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
Tom Foster
3311b084bf
Alphabetise avatar_url and displayname and remove redundant descriptions on displayname
2025-02-14 12:03:49 +00:00
Tom Foster
992cf9dc35
Clarify null behaviour for PUT and DELETE
2025-02-14 11:53:19 +00:00
Tom Foster
4f8999be0a
Tweak wording on full profile GET
2025-02-14 11:32:39 +00:00
Tom Foster
82adcec491
Clarify avatar_url should be MXC
2025-02-14 11:21:45 +00:00