Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-01-25 08:33:45 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
6567 commits 28 branches 42 tags 33 MiB
Commit graph

966 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
Stuart Mumford d6f38f157d
Add a sentence about what canonical JSON is (#1468) 
Signed-off-by: Stuart Mumford <stuart@cadair.com>
 2023-03-21 16:27:54 +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 bdc87784a1
Clarify that Persistent data unit is PDU (#1466) 
Signed-off-by: Stuart Mumford <stuart@cadair.com>
 2023-03-14 20:32:38 +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
David Robertson f9ea0f9d9b
Only include endpoint path in <summary> (#1446) 2023-03-02 16:58:04 +00:00
Richard van der Hoff a9e9202e89
Load Inter CSS directly (#1444) 
Move the load of the Inter font CSS from _variables_project.scss to head-end.html.

Empirically, this seems to fix #965
 2023-02-28 14:56:19 +00:00
Kévin Commaille 427f472331
Remove overridden references to examples/minimal_pdu.json and add the missing room_id field. (#1454) 
The syntax is incorrect and would require to use allOf
because a $ref can't have siblings.
However the only field not overwritten of that definition is room_id,
so we include it instead of the $ref

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2023-02-28 13:19:27 +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
Saiprakash Shet ea47197930
Update spelling in s2s authorization (#1431) 
* Issue #1231/Update spelling in s2s authorization

* Update spelling in s2s authorization.

* Apply suggestions from code review

---------

Co-authored-by: Travis Ralston <travpc@gmail.com>
 2023-02-15 21:09:29 +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
Hubert Chathi e9a463d871
Send heroes for nameless rooms on send_join (#1425) 
Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
 2023-02-07 15:50:31 -05:00
Travis Ralston 5c485ade2e Prepare changelogs for v1.6 2023-02-07 11:58:31 -07:00
Richard van der Hoff a7790fcbbf
Clarify room version grammar (#1422) 
Apparently the SHOULD is confusing
 2023-01-31 20:00:26 +00:00
Richard van der Hoff 05620913d5
Fix anchor for room-knocking heading (#1423) 
Fixes #1407
 2023-01-31 19:59:40 +00: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
Kim Brose d4586eba2e
Improve formatting of definitions in the Push Notifications section (#1415) 
Signed-off-by: Kim Brose <2803622+HarHarLinks@users.noreply.github.com>
 2023-01-29 10:22:12 -05:00
dylhack.dev f06ffc8176
replace "<content>" with "content" (#1370) 
* replace "<content>" with "content"

This parameter that's part of the content-repo openapi spec causes generators to mess up

* added changelogs

* Update changelogs/internal/newsfragments/1370.clarification

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

Co-authored-by: Travis Ralston <travpc@gmail.com>
 2023-01-16 19:50:14 +00:00
Catalan Lover fdd3d94a94
Change default room version from 9 to 10 (#1397) 
* Change default room version from 9 to 10 in accordance with MSC3904

* Add changelog entry with assumed PR number.

* Fix missing comma in changelog.

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

Co-authored-by: Travis Ralston <travpc@gmail.com>
 2023-01-08 13:59:30 -07:00
Kévin Commaille eb656dfce3
Add missing x-addedInMatrixVersion to servers_in_room in v2/send_join (#1398) 
* Add missing `x-addedInMatrixVersion` to `servers_in_room` in `v2/send_join`

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>
 2023-01-08 13:58:55 -07:00
Richard van der Hoff b8411b5159
Spec omit_members for /v2/send_join (#1393) 
Per MSC3706
 2023-01-04 12:12:49 +00:00
Kévin Commaille 9e45037129
Remove keyId from the server keys endpoints (#1350) 
* Remove keyId from the server keys endpoints

It has been deprecated forever.
Besides, the OpenAPI 3 spec doesn't allow optional path parameters.

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

* Add newsfragment

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

* Fix broken link

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

* Mention MSC3938 in newfragment

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

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2023-01-03 00:46:03 -07: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
Richard van der Hoff 7bd48ca9c7
Stop autogenerating examples where we already have one (#1384) 
If an object definition already has an example, we shouldn't try to extend that
definition by adding examples derived from the individual properties. Doing so
is confusing, and there is no way to inhibit it when it is not desired. It's
also not what the RapiDoc viewere does, so we end up with examples being
inconsistent.
 2022-12-21 16:24:11 +00:00
Richard van der Hoff 966f3c443a
Fix edu_type on EDU examples (#1383) 
The top-level `example` in `edu.yaml` was overriding the individual examples
for `edu_type`. Let's fix that by getting rid of the example in `edu.yaml`.

Fixes https://github.com/matrix-org/matrix-spec/issues/805
 2022-12-21 16:23:50 +00: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
Richard van der Hoff f386c903c0
Clarify that CNAMEs are permissible for server names (#1376) 
Fixes https://github.com/matrix-org/matrix-spec/issues/606.
 2022-12-14 10:53:50 +00:00
Travis Ralston 8a555fb411
Add some safety to the proposals script (#1368) 
* Add some safety to the proposals script

for if github's api explodes, forgets the header, or we are rate limited or something.

* changelog
 2022-12-08 12:41:55 -07:00
Richard van der Hoff 9555cbe5a9
Fix incorrect default "Invite level" (#1371) 2022-12-08 10:41:00 +00:00
Kévin Commaille 2e789736cc
Add newsfragment 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2022-11-28 13:06:34 +01:00
Johannes Becker e481fd011a
Add link to the unstable spec to the README (#1357) 2022-11-24 11:09:05 +00: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
Kévin Commaille 4534124742
Include examples inline instead of using a reference for invite endpoint definitions (#1349) 
The OpenAPI 3 spec doesn't allow building examples by composition.
Either the whole example must be a reference, or it has to be included.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2022-11-22 15:56:39 +00:00
Patrick Cloke eeb43043ad
Add standard error responses (MSC3743). (#1347) 2022-11-22 15:51:29 +00:00
Kévin Commaille dfc8a2e184
Fix POST _matrix/federation/v1/user/keys/claim response schema (#1351) 
The syntax was not compliant with the Swagger spec.
It also lacked one level of nesting.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2022-11-22 15:50:28 +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
Richard van der Hoff 1e393fbf92
Improve error messages emitted by resolve-additional-types (#1303) 
I forgot to set the `items` on an array definition, and got an extremely
opaque error. Hopefully this will improve the lives of anyone who makes a
similar mistake in future.
 2022-11-17 07:23:12 +00:00
Andrew Morgan cb2d5653ee
Add Event Replacements, Threading and Reference Relations modules to module summary table (#1344) 2022-11-17 00:07:04 +00:00
Andrew Morgan b5005e64f7
Document that non-spec changes should get an 'internal' changelog entry (#1342) 2022-11-16 13:44:55 +00:00
Richard van der Hoff f0246a5f12
Disable RSS for spec (#1346) 
This should really fix #1336
 2022-11-16 13:20:06 +00:00
Richard van der Hoff 3c9139bd5d
Unpack spec into right place for htmltest (#1338) 
Hopefully, fixes https://github.com/matrix-org/matrix-spec/issues/1336
 2022-11-15 23:30:17 +00:00
Richard van der Hoff 08fde5f257
Generate unstable changelogs using towncrier (#1340) 
Replace the current stack of hugo templates with a towncrier invocation. The main advantage of this is that it means that the "Changes since last release" section is consistent with the changelogs for the actual releases.

This also changes the release process so that the changelog is generated before tagging, which means that the thing tagged v1.5 is actually the v1.5 spec.

Fixes #908.
 2022-11-15 23:26:55 +00:00
David Baker 678f8b96f0
Merge pull request #1341 from matrix-org/dbkr/add_read_receipt_example 
Add example read receipt to sync example
 2022-11-15 20:47:18 +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
Richard van der Hoff bc15d4f9bc
Make definition anchors more unique (#1339) 
Stick a `definition-` on the front of the autogenerated anchors for definition
blocks.

This solves a problem where, for example,
https://spec.matrix.org/unstable/application-service-api/#registration could
refer to either the "Registration" section or the `Registration` definition
therein.

(These anchors are relatively recent: they were added in #1191.
 2022-11-15 19:15:34 +00:00
David Baker 26528c05c5 Newsfragment 2022-11-15 18:48:02 +00:00
Kévin Commaille b38cd08fbd
Add newsfragment 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2022-11-09 10:29:29 +01: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 b9952f1a74
Merge pull request #1329 from matrix-org/rav/htmltest 
Add link checker to CI
 2022-11-08 21:11:11 +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 8dd89e0510 changelog 2022-11-08 19:00:38 +00:00
Richard van der Hoff 4d0c912acf changelogs 2022-11-08 18:56:13 +00:00
Andrew Morgan fd41d9d4ed
Update docsy (hugo theme) git submodule (#1295) 2022-11-08 17:29:10 +00:00
Richard van der Hoff b07fe504ed
Stop rendering CS modules and room version fragments as standalone pages (#1317) 
This is actually doing two things:

 * creating `{fragments,modules}/index.md` turns the fragments and modules into
   page resources, rather than pages in their own right. We have to update the
   shortcodes to match.

 * adding `headless: true` means that we don't render the pages.

The net effect is that we don't render pages like
https://spec.matrix.org/v1.4/rooms/fragments/v1-auth-rules/ and
https://spec.matrix.org/v1.4/client-server-api/modules/account_data/.
 2022-11-08 17:27:44 +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
Richard van der Hoff 1945589acf
Clarifications to AS spec, including MSC3905 (#1305) 
Primarily this is the spec for MSC3905, but I've also taken the opportunity to clean up the section a bit and move the definition out to a .yaml file.
 2022-11-08 15:01:46 +00: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
Alexandre Franke 39f79fe521
Update link to API viewer (#1308) 
* Update link to API viewer

Fixes #2
 2022-11-01 15:06:59 +00: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
Richard van der Hoff 11cef5417a
Clarify auth rules for m.room.power_levels events (#1269) 2022-10-12 13:36:02 +01: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
Richard van der Hoff c4505665e0
Various clarifications to auth rules text (#1270) 2022-10-05 16:54:34 +00: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