Commit graph

625 commits

Author SHA1 Message Date
Richard van der Hoff d26794ee90
Clarify terminology around aggregations (#1424)
I've done my best to remove the word "bundle", because I feel like it causes
more confusion than it provides. Instead I have favoured "aggregated child
events" which I think is clearer.

Some general clarification around these parts of the spec.
2023-03-21 18:27:24 +00:00
Richard van der Hoff acb631d3d6
Change the server aggregation for edits (#1440)
per matrix-org/matrix-spec-proposals#3925
2023-03-21 15:59:23 +00:00
Stuart Mumford 09e2250a8d
Spec implicit filter event limit (#1463)
Signed-off-by: Stuart Mumford <stuart@cadair.com>
2023-03-14 20:27:42 +00:00
Andrew Morgan 35f5439e00
Correct a small typo in the push rules spec (#1465 2023-03-14 15:43:44 +00:00
Patrick Cloke 53d7de2376
Define how clients process push rules (#1461)
* Move Push Rules section out from Client Behaviour.
* Clarify server vs. client behavior.
* Remove references to unencrypted content.
2023-03-14 14:57:52 +00:00
Patrick Cloke afae1083aa
Clarify what key content-specific rules match against. (#1441) 2023-03-08 13:06:06 +00:00
Alexey Rusakov b441b19cc3
More cleanup before upgrading to OpenAPI 3.1 (#1455)
* `cross_signing_key.yaml`: the parameter documentation already restricts the number of properties
 * `receipts.yaml`: use `maxProperties: 0` to say the object is empty (the comment is still there but is not really needed any more)
 
Signed-off-by: Alexey Rusakov <Kitsune.Ral@users.sf.net>
2023-03-08 10:39:06 +00:00
Andrew Morgan c0955a6aee
Add a hyphen between third and party when used as an adjective (#1447) 2023-03-08 09:58:29 +00:00
Alexey Rusakov 9ebcf5f257
OpenAPI compliance: avoid $ref siblings (#1457)
This strives to fix all remaining cases where additional attributes
(most often 'description' but not only) are provided next to $ref
by wrapping $ref in allOf; and also drops allOf in a couple of places
where $ref is the only element under it.
2023-03-07 16:51:30 +00:00
Hugh Nimmo-Smith 10844fef8c
Clarification to transaction identifier idempotent semantics (#1449) 2023-03-07 16:45:14 +00:00
Richard van der Hoff 77d0f20226
Remove spurious 'weight: 340' (#1442) 2023-02-22 11:35:36 +00:00
Jonas Platte 71b2235868
Clarify that reply chain fallback for threads may not be present (#1439) 2023-02-21 17:38:48 +00:00
Andrew Morgan 5c7bb2fcd5
Remove some erroneous underscores from the Client-Server spec text (#1432)
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2023-02-14 17:08:47 +00:00
Travis Ralston 029e988835 Matrix 1.6 2023-02-14 08:26:14 -07:00
DeepBlueV7.X a383698be5
Improve distinction between tags and their attributes in the rich text section (#1433)
Originally the tags used to be bold, followed by a colon and separated
into two columns in a table. This at least restores the table aspect,
which makes it clear, that font is not an attribute (and similar).

This seems to have gotten lost in the transition to the new design.

Signed-off-by: Nicolas Werner <nicolas.werner@hotmail.de>
2023-02-13 15:36:52 -05:00
Andy Balaam b5566dbadb
Clarify which events will be included in Stripped State (#1409)
Signed-off-by: Andy Balaam andy.balaam@matrix.org
2023-02-13 10:36:58 +00:00
Richard van der Hoff 6b02e39308
Move .m.rule.roomnotif before .m.rule.tombstone (#1421)
See https://github.com/matrix-org/matrix-spec/issues/1406 for the reasoning on
this. TL;DR: the spec has always been wrong here.
2023-02-10 12:04:24 +00:00
Hubert Chathi ad94985754
Define hkdf-hmac-sha256.v2 MAC method for SAS verification (#1412)
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2023-02-09 23:58:16 -05:00
Travis Ralston 5c485ade2e Prepare changelogs for v1.6 2023-02-07 11:58:31 -07:00
Kévin Commaille d55af02738
Add links to the spec for the definition of 3PID medium (#1417)
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2023-01-30 11:36:51 +00:00
Hubert Chathi eb2456c7d4
Improve documentation around one-time keys and key types (#1381) 2022-12-24 22:03:44 -05:00
Hubert Chathi 94465fe93b
Add spec for getting events by timestamp (#1366) 2022-12-21 14:05:28 -05:00
Kim Brose 05d2bc4c95
move login API definitions to the right heading (#1382)
* move login API definitions to the right heading

regressed from https://github.com/matrix-org/matrix-spec-proposals/pull/3324

* Create 1382.clarification
2022-12-19 15:47:00 -07:00
Kévin Commaille 2e789736cc
Add newsfragment
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2022-11-28 13:06:34 +01:00
Kévin Commaille 8d4a3bb912
Clarify what fields are required when deleting a pusher (#1321)
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2022-11-22 17:12:13 +00:00
Sumner Evans 84fbb611db
Clarify that /context always returns 'event' even if limit is zero (#1239)
Signed-off-by: Sumner Evans <me@sumnerevans.com>
2022-11-22 17:08:46 +00:00
Johannes Becker 3f3b5c39f0
Remove duplicated "Note:" from m.room.power_levels (#1355)
Remove duplicated "Note:"

Signed-off-by: Johannes Becker <j.becker@famedly.com>
2022-11-22 16:57:38 +00:00
David Robertson 07442876ce
Improve presentation of push rules kinds and actions (#1348) 2022-11-22 16:01:23 +00:00
Patrick Cloke eeb43043ad
Add standard error responses (MSC3743). (#1347) 2022-11-22 15:51:29 +00:00
Johannes Becker b2c4abf567
Clarify the power levels integer range (#1169)
Signed-off-by: Johannes Becker <j.becker@famedly.com>
2022-11-22 15:45:30 +00:00
Kim Brose 8830314401
Create 1353.clarification 2022-11-18 14:33:52 +01:00
Travis Ralston 5f2fac89af Matrix 1.5 2022-11-17 08:22:20 -07:00
Hubert Chathi 684ead8ab6
Merge pull request #1294 from uhoreg/rhul_clarifications
add some e2ee clarifications
2022-11-17 09:21:51 -05:00
Hubert Chathi 2fcc92c2fb
improve documentation of ephemeral events (#1284) 2022-11-17 07:53:15 +00:00
Hubert Chathi 64922771d4
Clarify that verifications without a request only happens over to-device (#1345) 2022-11-17 07:27:40 +00:00
David Baker d620ff7a7c
Better newsfragment
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
2022-11-15 20:24:18 +00:00
David Baker 26528c05c5 Newsfragment 2022-11-15 18:48:02 +00:00
Richard van der Hoff 498cf6d147
Merge pull request #1320 from zecakeh/master-pushrule
Clarify that `.m.rule.master` has a higher priority than any push rule
2022-11-08 21:56:39 +00:00
Richard van der Hoff 44c7eb5b88
Merge pull request #1330 from matrix-org/rav/fix_dead_links
Fix broken links
2022-11-08 21:10:48 +00:00
David Baker f53da89996
Merge pull request #1318 from zecakeh/pushrules-set-sound
Replace `set_sound` push rule action by `set_tweak`
2022-11-08 20:49:46 +00:00
BramvdnHeuvel 6879f96c90
Require refresh_token on refresh token endpoint (#1323)
Signed-off-by: Bram van den Heuvel matrix-spec@noordstar.me
2022-11-08 19:24:37 +00:00
Kévin Commaille 8526e4fcd9
Clarify the behavior of PUT /pushrules/{scope}/{kind}/{ruleId} (#1319)
This is based on the behavior of Synapse and Dendrite. Conduit's implementation is already non-compliant in regards to what was already defined in the spec.

Closes #645.
Related to #647 (probably closes it too, unless we want to be more explicit somewhere about what can be changed on default push rules).

Related PR in ruma that would allow to fix Conduit's implementation: ruma/ruma#1364

Signed-off-by: Kévin Commaille zecakeh@tedomum.fr
2022-11-08 19:20:38 +00:00
Richard van der Hoff 4d0c912acf changelogs 2022-11-08 18:56:13 +00:00
Kévin Commaille fc624328df
Change newsfragment
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2022-11-08 17:53:58 +01:00
Kévin Commaille f428ba1499
Add newsfragment
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2022-11-03 10:44:12 +01:00
Kévin Commaille 306d1aac5d
Add newsfragment
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2022-11-03 09:17:23 +01:00
Hubert Chathi 830f80f56a
Merge pull request #1271 from uhoreg/add_verification_request_msgtype
add in-room m.key.verification.request msgtype
2022-11-02 10:16:42 -04:00
Hubert Chathi 82d2dd4ab0
Merge pull request #1283 from uhoreg/fix_event_subtype
improve display of event subtypes
2022-11-02 10:15:56 -04:00
Hubert Chathi 2395dd87c0 more clarifications, and move event definitions to yaml 2022-11-01 17:49:45 -04:00
Andrew Morgan c8242eeb35
Replace misuses of 'plaintext' with 'cleartext' and clarify spoiler docs (#1306) 2022-10-27 09:23:44 +00:00
Travis Ralston b2cc836649
Spec reference relationships (#1206)
* Spec reference relationships

MSC: https://github.com/matrix-org/matrix-spec-proposals/pull/3267

* Apply suggestions from code review

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>

* Edits per code review

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2022-10-18 11:50:41 -06:00
David Robertson ad99be4ad7
Define a 400 response from {PUT,GET,DELETE} /directory/rooms/{roomAlias} (#1286)
* Define a 400 response from {PUT,GET,DELETE} `/directory/rooms/{roomAlias}`

* Changelog

* Adjust changelog

Co-authored-by: Travis Ralston <travpc@gmail.com>

* Refer to appendices

Co-authored-by: Travis Ralston <travpc@gmail.com>
2022-10-17 15:49:01 -06:00
Hubert Chathi 089f1fee7d add changelog 2022-10-12 16:02:07 -04:00
Andrew Morgan 3808a679c1
Fix up description of knock_room_state field, which implied the required field was optional (#1276) 2022-10-07 13:46:37 +01:00
Andrew Morgan 43a48314ac
Remove reference to a room_id key for typing events (#1265) 2022-10-05 09:54:58 +00:00
Erik Johnston 4bda06a886
Merge pull request #1266 from matrix-org/erikj/clarfiy_otks 2022-10-05 10:02:27 +01:00
Hubert Chathi 9d8e17fb22 add changelog 2022-10-04 17:53:15 -04:00
Travis Ralston 1cdfbd3cd8
v1.4 patch release cleanup (#1268)
* Add missing steps to patch release guidelines

* Update from v1.4 patch
2022-10-04 10:00:16 -06:00
Erik Johnston b8e7c4e133 Newsfile 2022-10-04 16:01:55 +01:00
Kévin Commaille d3d4afdbfd
Receipts: Add thread_id to the /receipt endpoint (#1261)
* Receipts: Add thread_id to the /receipt endpoint

It seems to have been omitted in #1255

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

* changelog

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

* Fix missing backtick

* Apply suggestion for error description

Co-authored-by: Travis Ralston <travpc@gmail.com>

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
Co-authored-by: Travis Ralston <travpc@gmail.com>
2022-10-04 08:09:23 -06:00
Val Lorentz 460bea4024
Fix definition of data-mx-color values (#1260)
* Fix definition of `data-mx-color` values

* Create 1260.clarification

* Update changelogs/client_server/newsfragments/1260.clarification

Co-authored-by: Travis Ralston <travpc@gmail.com>

Co-authored-by: Travis Ralston <travpc@gmail.com>
2022-10-03 23:31:10 -04:00
Val Lorentz 3c796e9876
Aggregations: remove not about "future extensions" (#1263)
* Aggregations: remove not about "future extensions"

It is now used by threading.

* Create 1263.clarification
2022-10-03 23:26:31 -04:00
Travis Ralston 7a591366c1 v1.4 changelog 2022-09-29 07:03:48 -06:00
Travis Ralston 227757d499
Threads: Read receipts & notifications (#1255)
* Spec MSC3771: Threaded read receipts

Note: this builds on a (as of writing) non-existent "threading" section, which is part of a different commit.

* Spec MSC3773: Threaded notifications

* changelog

* Various clarifications per review
2022-09-28 14:49:25 -06:00
Travis Ralston 25dda1eadb
Threads: The base (#1254)
* Spec MSC3440: Threading (just the base)

Other threading MSCs to follow

* Spec MSC3856: Threads list API

* Spec MSC3715:  Add`dir` to `/relations`

* changelog

* Apply suggestions from code review

Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>

* Update changelogs/client_server/newsfragments/1254.feature

Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>

Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
2022-09-27 13:51:20 -06:00
Travis Ralston 6c6c602845
Clarify that refreshed access tokens don't invalidate the scope of txnid (#1236) 2022-09-26 14:39:43 -06:00
Michael Telatynski 7ab3aecf29
Update profile.yaml (#1238)
* Update profile.yaml

* Create 1238.clarification

* Update changelogs/client_server/newsfragments/1238.clarification

Co-authored-by: Alexey Rusakov <Kitsune-Ral@users.sf.net>

Co-authored-by: Alexey Rusakov <Kitsune-Ral@users.sf.net>
2022-09-22 09:04:50 -06:00
Andrew Morgan e7e376142e
Fix typos in the spec related to account data (#1243) 2022-09-22 11:25:32 +01:00
Richard van der Hoff 58e6900891
Spec event edits (#1211)
Per matrix-org/matrix-spec-proposals#2676
2022-09-21 14:41:28 +01:00
Patrick Cloke 1c0101ce4c Put commas between enum values. 2022-09-16 09:03:41 -04:00
Travis Ralston e406bd94f6
Spec MSC2285: Private read receipts (#1216)
* Convert `m.receipt.yaml` to traditional YAML

* Spec MSC2285 (private read receipts)

* Add some obvious copyright headers

* Add changelog entries

* Appease the linter

Apparently it hates it when you do this.

* Allow m.fully_read on /receipts

* Apply suggestions from code review

Co-authored-by: Matthew Hodgson <matthew@matrix.org>

Co-authored-by: Matthew Hodgson <matthew@matrix.org>
2022-09-12 16:34:51 -06:00
Will Hunt 8df0cfeae0
s/room/rooms (#1215)
* s/room/rooms

Fixes #979

* Create 1215.clarification
2022-08-26 13:53:28 -06:00
Andrew Morgan 5572d33453
Require access_token, device_id and user_id fields in /login response (#1210) 2022-08-16 18:12:10 +01:00
Travis Ralston afc0e6a026
Add CORP headers to media repo (#1197)
* Add CORP headers to media repo

MSC: https://github.com/matrix-org/matrix-spec-proposals/pull/3828

* Write weird CSS rules to make added-in work inline in the CS spec

Even though our content doesn't need 2 paragraphs, it's good to have the capability to render it in the future.

* Remove test paragraph

* Refine prose

* spelling is key
2022-08-09 10:44:51 -06:00
Travis Ralston b14759a27b
Add room_types and room_type to /publicRooms (#1199)
MSC: https://github.com/matrix-org/matrix-spec-proposals/pull/3827
Incorporates https://github.com/matrix-org/matrix-spec-proposals/pull/3858
2022-08-04 15:15:16 -06:00
Travis Ralston 9506ecea59
Add missing annotation for v1.4 on ACL push rule (#1201)
* Add missing annotation for v1.4 on ACL push rule

* changelog
2022-08-04 11:40:42 -06:00
Travis Ralston 9093a5f16f
Copy room type on upgrade too (#1198)
MSC: https://github.com/matrix-org/matrix-spec-proposals/pull/3818
2022-08-03 13:09:14 -06:00
Travis Ralston 3c45c0aeb4
Remove unused policy room sharing mechanism, as per MSC3844 (#1196)
MSC: https://github.com/matrix-org/matrix-spec-proposals/pull/3844
2022-08-03 11:31:24 -06:00
Richard van der Hoff f24cad1653
Add push rule for m.room.server_acl (#1190)
* Add push rule for `m.room.server_acl`

... per MSC3786.

* Update changelogs/client_server/newsfragments/1190.feature

Co-authored-by: Travis Ralston <travisr@matrix.org>
2022-08-02 16:53:00 -06:00
David Robertson 69ff51c017
Tweak style of <code> samples in rendered tables (#1179)
* Tweak style of `<code>` samples in rendered tables

This has been subtly irritating me for aaaaaaages

* Changelogs
2022-08-02 14:49:27 +01:00
Richard van der Hoff b232148821
Clarify the use of JSON in requests and responses (#1185)
Fixes #1182
2022-07-28 13:45:54 +01:00
David Robertson 077f414cd0
Update changelogs/client_server/newsfragments/1180.clarification
Co-authored-by: Hubert Chathi <hubert@uhoreg.ca>
2022-07-25 10:59:30 +01:00
David Robertson 494f903f71
Changelog 2022-07-21 18:47:54 +01:00
Richard van der Hoff ea42cd3c7b
Move various e2e defintions out to yaml files (#1166)
We have code to generate tables, which we should use in the e2e section.
2022-07-19 22:02:48 +01:00
Richard van der Hoff 5f3b34448d
Add HTML ids for object definitions in the formatted specification (#1174)
* Remove redundant call to resolve-allof

All of the callers to resolve-additional-types already call resolve-allof (or
if not, they should), so this is redundant.

* Update `resolve-additional-types` to take a dict

I want to add more params to this, so first make it take a dict.

* `render-object-table`: take a "title" rather than a "caption"

... which means we can use the result from resolve-additional-types directly.

* render-object-table: support adding an anchor to generated tables.

* resolve-additional-types: generate an id for each returned type

* render-event: pass an anchor_base into resolve-additional-types

This means that it will generate an anchor for each type, whihc will then be
passed into render-object-table and used as an `id` for the table.

* render-operation: pass an anchor_base into resolve-additional-types

* newsfiles
2022-07-19 13:25:30 -06:00
David Robertson f9028acf8e
Describe return codes for account data endpoints + minor clarifications (#1155) 2022-07-14 13:01:56 +01:00
Travis Ralston 56400ab9a0
Add missing "added in" spec version to some key backup endpoints (#1170)
* Add missing version to some key backup endpoints

* Create 1170.clarification
2022-07-13 12:43:37 -06:00
Brad Murray ead437578b
Fix typo in m.secret.request device event name (#1135)
* Fix typo in m.secret.request device event name

I don't think this is supposed to be plural according to the various SDKs

* Add changelog

* Update changelogs/client_server/newsfragments/1135.clarification

* Update changelogs/client_server/newsfragments/1135.clarification

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
Co-authored-by: Travis Ralston <travpc@gmail.com>
2022-07-12 10:59:44 -06:00
David Florness adaef611dc
Fix typo (#1161)
Signed-off-by: David Florness <david@florness.com>
2022-07-12 17:39:37 +01:00
DeepBlueV7.X 5bf35327c6
Fix wording for globs in policy lists (#1165)
* Fix wording for globs in policy lists

The specification here does neither match how globs work in common
libraries nor do they match how they are used in practice currently or
how the MSC worded them (which said they should be like server ACLs). As
such this seems to be an issue introduced when writing the spec text.

Ref mjolnir:
- b48904bc2b/src/models/ListRule.ts (L44)

Ref matrix bot sdk (which implements the glob used above):
- 473e563236/src/helpers/MatrixGlob.ts (L26)
- f799b1fe1a/test/helpers/MatrixGlobTest.ts (L44)

Ref original MSC:
- c7b3d99853/proposals/2313-moderation-policy-rooms.md?plain=1#L36
- https://spec.matrix.org/v1.3/client-server-api/#server-access-control-lists-acls-for-rooms

fixes https://github.com/matrix-org/matrix-spec/issues/17

Signed-off-by: Nicolas Werner <nicolas.werner@hotmail.de>

* Add changelog

Signed-off-by: Nicolas Werner <nicolas.werner@hotmail.de>
2022-07-11 13:58:27 -06:00
Hubert Chathi 577eb5db59 add changelog 2022-07-07 11:28:38 +01:00
Will Hunt cf6544c028
Clarify that /invite will respond with 200 if the user is already invited to the room (#1084)
* Clarify that /invite will respond with 200 if the user is already in the room

* Create 1084.clarification

* Update changelogs/client_server/newsfragments/1084.clarification

Co-authored-by: Travis Ralston <travpc@gmail.com>
2022-07-04 13:19:33 -06:00
Travis Ralston 98db9a6d04 v1.3 changelog generation 2022-06-16 08:31:07 -06:00
Alexey Rusakov 6792b7a9d6
Use type: integer, format: int64 for timestamps (#1129)
* Use type: integer / format: int64 for timestamps

Closes #749.

* Changelog
2022-06-15 00:32:55 -06:00
Alexey Rusakov 6adacd18c1
Arrange a few titles (#1126)
* Arrange a few titles

Before this change, PublicRoomsChunk in the spec text could be found in
two places (actually three but the third one is identical to the first
one), defining two (_mostly_ identical but) different schemas.
Ctrl-F'ing through the spec may confuse you with the "wrong" definition.
This commit gives distinct schemas distinct names; aside from
PublicRoomChunk, the same story happens with the derivative of
stripped_state.yaml used in space_hierarchy.yaml (it's not exactly
StrippedStateEvent either).

As for the removal of `PublicRoomsChunks` (plural) - this title is
unnecessary because the tooling would place rather self-explanatory
`[PublicRoomsChunk]` without it, whereas the plural title ends up with
no definition in the spec text.

* Add changelog
2022-06-14 22:04:10 -06:00
Alexey Rusakov dcc1f4adee
keys.yml: fix one_time_keys object contents (#1127)
* keys.yml: fix one_time_keys object contents

The alternatives previously listed under two additionalProperties levels
are actually one _more_ level deeper; we still can't define them in
a formal way before moving to OpenAPI 3 but at least let's be honest
and say there's always a dict where there's always a dict. Also,
since the same data structure is used in three places now, at least
give it a name, and document the actual definition (once) separately
(not using it now because it's OpenAPI 3).

* Changelog
2022-06-14 22:03:53 -06:00
Alexey Rusakov 980d9cd6e9
openapi_extensions.md: fix typos and leftovers (#1128)
* openapi_extensions.md: fix typos and leftovers

dump-swagger had to substitute things in the past - these days it
just merges definitions.

* Changelog
2022-06-14 22:02:52 -06:00
Alexey Rusakov cbdd889fa8
auth_data.yaml: formally allow it to be non-object (#1115)
Closes #716.

Signed-off-by: Alexey Rusakov Kitsune-Ral@users.sf.net
2022-06-14 16:35:18 +01:00
Hubert Chathi 3fbaced8be
Merge changelog with changelog for #1056 2022-06-13 05:27:17 -04:00
Kévin Commaille 86f984b1b6
Changelog
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2022-06-11 17:52:48 +02:00