wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
6583 commits 4 branches 0 tags 17 MiB
Commit graph

6583 commits

This branch
This branch
All branches
Author SHA1 Message Date
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
David Baker
312a0e9b05 Add example read receipt to sync example 
Fixes https://github.com/matrix-org/matrix-spec/issues/120
 2022-11-15 18:43:58 +00:00
Richard van der Hoff
ac1c5ad2bb
Merge pull request #1331 from zecakeh/swagger-preview 
Update instructions to preview Swagger definitions
 2022-11-15 16:29:48 +00:00
Richard van der Hoff
12b4d8ad95
Update README.md 2022-11-15 16:28:10 +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
Kévin Commaille
9b4773498a
Update instructions to preview Swagger definitions 
Use RapiDoc, the same library used in production.
It is also compatible with OpenAPI 3.1.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2022-11-09 10:25:56 +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
9e8360560b Uniquify some links 
The link checker doesn't understand that we dynamically re-assign element IDs
at load time, so was failing for a few links that were technically valid
(though presumably still broken for any client not using JS).

Work around this by manually setting a few anchors, linking to other nearby
bits of text, or just changing heading titles.
 2022-11-08 19:00:38 +00:00
Richard van der Hoff
3e074ed6d3 Add htmltest github action 2022-11-08 19:00:38 +00:00
Richard van der Hoff
4d0c912acf changelogs 2022-11-08 18:56:13 +00:00
Richard van der Hoff
6cbb88f9df Fix broken links 
A bunch of broken links I found
 2022-11-08 18:54:26 +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
ea7e1c8af9
Clarify that .m.rule.master has a higher priority than any push rule 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2022-11-03 10:34:26 +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
Kévin Commaille
392794950b
Replace set_sound push rule action by set_tweak 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
 2022-11-03 09:11:49 +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
dd0f867fad make examples agree with schema 2022-11-01 17:56:29 -04:00
Hubert Chathi
2395dd87c0 more clarifications, and move event definitions to yaml 2022-11-01 17:49:45 -04:00
Hubert Chathi
d0d7bdb807 apply changes from code review 2022-11-01 11:39:15 -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
Hubert Chathi
60d9518a63 pass the desired example name to the template 2022-10-28 16:15:04 -04:00
Andrew Morgan
c8242eeb35
Replace misuses of 'plaintext' with 'cleartext' and clarify spoiler docs (#1306) 2022-10-27 09:23:44 +00:00
Hubert Chathi
d6345f0df2 apply changes from code review 2022-10-26 16:33:41 -04:00
Hubert Chathi
fbbf3b81c5 add some e2ee clarifications 2022-10-18 18:02:27 -04: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
f76ff36545 add links 2022-10-12 16:32:00 -04:00
Hubert Chathi
76bf60a12f set the title of m.key.verification.request in-room event 2022-10-12 16:08:38 -04:00
Hubert Chathi
089f1fee7d add changelog 2022-10-12 16:02:07 -04:00
Hubert Chathi
99cd692ed0 improve display of event subtypes 2022-10-12 15:49:21 -04:00
Hubert Chathi
c0d54ab4d9
Apply suggestions from code review 
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
 2022-10-12 09:52:04 -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