Tom Foster
7076b290dd
Merge 6183f2410f into c7581356bf
2025-03-23 12:00:06 +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
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
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
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
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
Tom Foster
ee9b5ddcca
Correct types and errors
2025-02-14 11:02:11 +00:00
Tom Foster
59d2c62d2d
Link to MSC4133 in endpoint descriptions
2025-02-14 10:40:09 +00:00
Tom Foster
212377e393
Merge branch 'matrix-org:main' into MSC4133
2025-02-14 09:50:59 +00:00
Tom Foster
fdc012ac01
Describe MSC4133 profile endpoint changes
2025-02-13 17:54: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
a1bdfaa167
Remove the origin field in PUT /send_join responses ( #2050 )
...
* Remove the `origin` field on PUT /send_join responses
This is a spec bug as it has actually never been sent by Synapse, going back to 2014.
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-01-21 22:55:27 +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
Kévin Commaille
96b32f68f9
Allow sending ephemeral data to application services ( #2018 )
...
As per MSC2409.
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2024-12-11 22:38:59 +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
2024-11-12 22:24:20 +00:00
Johannes Marbach
74e8be3fd9
Clarify that pusher URLs have a fixed path ( #1974 )
...
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
2024-11-07 14:56:53 +00:00
