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

196 commits

Author SHA1 Message Date
Travis Ralston
e9e93b0eec Move invite_room_state to the correct place in the client-server API 
Fixes https://github.com/matrix-org/matrix-doc/issues/1350
 2018-08-26 20:51:39 -06:00
Travis Ralston
3869f68a5c Merge remote-tracking branch 'matrix-org/master' into travis/general/room-versions 2018-08-21 12:22:35 -06:00
Valentin Deniaud
f853856f21 add missing m.room.encrypted event properties 2018-08-18 11:41:45 +02:00
Valentin Deniaud
6c44233c42 require megolm algorithm in m.room.encryption 2018-08-18 11:41:45 +02:00
Valentin Deniaud
661176cb3a Olm m.room.encrypted example 2018-08-18 11:41:45 +02:00
Valentin Deniaud
8732378da2 add required room ids 2018-08-18 11:41:45 +02:00
Valentin Deniaud
c60109d235 complete m.room_key documentation 2018-08-18 11:41:45 +02:00
Valentin Deniaud
3a8d13df60 add missing m.room.encryption properties 2018-08-18 11:41:45 +02:00
Valentin Deniaud
e5005b2d0f document E2E events 
This was written by Richard van der Hoff.
 2018-08-18 11:41:45 +02:00
Travis Ralston
fde48e7ee8 Specify how room versioning works 
This is the spec PR for https://github.com/matrix-org/matrix-doc/issues/1425

Room version upgrades are not part of MSC1425.

Documented aspects:
* room_version on the create event
* creating a room with a specific version (useful for testing)
* make_join behaviour
* error code documentation
* grammar of room versions

Based upon https://docs.google.com/document/d/1urKgReoHqxX8R_XtySB17dPi-DZcKhqTEL2_s895Wz0/edit
 2018-08-15 15:12:36 -06:00
Travis Ralston
55e4e90ab1 Document message formats as-is 
This is likely to later be replaced by mixins, however this is being documented now so clients aren't left in the dark.

Fixes https://github.com/matrix-org/matrix-doc/issues/917
 2018-07-10 12:52:11 -06:00
Richard Lewis
8d05f80cec Sticker messages (m.sticker) (#1158) 2018-03-27 10:00:41 +01:00
Travis Ralston
6e7d264bc7 Add clarity to the m.ignored_user_list 
Signed-off-by: Travis Ralston <travpc@gmail.com>
 2018-03-06 10:32:18 -07:00
Travis Ralston
0835612277 Represent the ignored users event correctly 
Signed-off-by: Travis Ralston <travpc@gmail.com>
 2018-03-06 10:21:38 -07:00
Travis Ralston
af74790681 Merge remote-tracking branch 'matrix-org/master' into travis/m.ignored_user_list 2018-03-06 10:18:24 -07:00
Travis Ralston
331e49bd0d Improve the documentation of ignored users 
* Fix the event schema to represent the real world
* Add the module to the spec targets
* Remove incomplete thought from the client behaviour
* Link to the account data API
* Minor word choice changes

Signed-off-by: Travis Ralston <travpc@gmail.com>
 2018-03-06 09:00:32 -07:00
Travis Ralston
eb8c3255bf Remove extraneous comma from m.presence schema 
This causes the build to fail. Fixes #1146

Signed-off-by: Travis Ralston <travpc@gmail.com>
 2018-03-05 18:45:57 -07:00
Travis Ralston
d37ed0876f
Merge branch 'master' into travis/m.ignored_user_list 2018-03-05 14:52:37 -07:00
Richard van der Hoff
a0dda3cae2
Merge branch 'master' into travis/m.tag 2018-03-05 18:58:53 +00:00
Travis Ralston
e862ef60ae Spec ignoring users 
Adds https://github.com/matrix-org/matrix-doc/issues/528

Signed-off-by: Travis Ralston <travpc@gmail.com>
 2018-03-03 15:39:10 -07:00
Travis Ralston
a3f006353c Tag ordering is defined as a number between 0 and 1, not strings 
Signed-off-by: Travis Ralston <travpc@gmail.com>
 2018-03-03 12:40:48 -07:00
Travis Ralston
a488bd5503 Make m.presence match what synapse returns 
Considering this is the behaviour that is embedded into most client libraries and the most popular homeserver, it should be adopted as the standard.

Signed-off-by: Travis Ralston <travpc@gmail.com>
 2018-03-03 12:12:47 -07:00
Max Dor
57e5e1e331 Document default room creator PL (#1081) 2017-11-20 16:22:30 +00:00
Richard van der Hoff
e5e249dce1 Remove redundant 'Required' annotations from event fields 2017-11-03 17:17:59 +00:00
Richard van der Hoff
23e2f8986c Merge pull request #1026 from matrix-org/rav/power_levels_doc 
Clarify what happens when there is no power_levels event
 2017-10-17 20:54:18 +01:00
Richard van der Hoff
b4e24d443a Clarify what happens when there is no power_levels event 2017-10-17 16:34:50 +01:00
Travis Ralston
a1265a274b Add spec for m.room.pinned_events 
Signed-off-by: Travis Ralston <travpc@gmail.com>
 2017-09-29 11:59:27 -06:00
Brendan Abolivier
0b74492d67 Fix membership on third-party invite upgrade (#995) 2017-09-26 14:57:51 +01:00
krombel
f8ce497bd6 Fix inconsistency: join_rules => join_rule 
All other docs do not have `join_rules` but `join_rule`
This PR fix this inconsistency.

Mentioned by @digital:sorunome.de in [#matrix-dev:matrix.org](https://matrix.to/#/!XqBunHwQIXUiqCaoxq:matrix.org/$150142347531959wjGGm:sorunome.de)
 2017-07-31 12:04:24 +02:00
Brendan Abolivier
750d980bc0 Room member (#950) 
* Fixed an incorrect membership on example
* Added precision on membership upon profile update
* Changed first example into a join
* Changed the state/{eventType}/{stateKey} example with an actual state key
 2017-07-14 15:30:56 +01:00
Michael Telatynski
852f4edead redacts is an eventID not a roomID (! -> $) 2017-07-05 16:18:49 +01:00
Johannes Löthberg
c1b375b2ac Clarify that age is generated on the local HS 
Signed-off-by: Johannes Löthberg <johannes@kyriasis.com>
 2016-11-30 23:12:47 +01:00
Johannes Löthberg
d9894aeffd Make m.notice description use stricter language 
Signed-off-by: Johannes Löthberg <johannes@kyriasis.com>
 2016-11-30 00:59:51 +01:00
Mark Haines
6f1c598db8 Make the key orders consistent 2016-11-07 14:54:59 +00:00
Mark Haines
05001bcaa6 Fix whitepace 2016-11-07 14:32:48 +00:00
Mark Haines
29e33deeb5 Fix m.location example 2016-11-07 14:31:29 +00:00
Mark Haines
30f9ea0225 Spelling 2016-11-07 14:30:16 +00:00
Mark Haines
5ccf41bafc Add type: object 2016-11-07 14:29:17 +00:00
Mark Haines
6ecb5d0729 re-order thumbnail keys 2016-11-07 14:28:19 +00:00
Mark Haines
4349982189 Fix path 2016-11-07 10:54:02 +00:00
Mark Haines
2fdca5a995 Add a thumbnail_info common schema, deduplicate m.room.avatar and m.room.message#m.image 2016-11-07 10:50:52 +00:00
Mark Haines
1b661b64dc Move m.location thumbnail_url to be inside info to match m.video 2016-11-04 14:59:39 +00:00
Mark Haines
14d05464ee Move m.file thumbnail_url to be inside info to match m.video 2016-11-04 14:57:45 +00:00
Mark Haines
25b41c7551 Move m.image thumbnail_url to be inside info to match m.video 2016-11-04 14:52:01 +00:00
Richard van der Hoff
dfbe416490 Better types for additionalProps 
recurse down the definitions for additionalProps, so that the types are better
 2016-10-14 15:57:52 +01:00
David Baker
4480553bf9 Move m.direct description to the swagger 
Also change the swagger to yaml so I can put that description in it
without having to figure out how to embed that in json.
 2016-10-05 13:12:14 +01:00
David Baker
b789251f70 More PR feedback 2016-10-05 12:59:49 +01:00
David Baker
8af90bfc21 Clarify 'this room' 2016-10-04 15:08:48 +01:00
David Baker
85bc989c02 pr feedback 2016-10-04 15:07:14 +01:00
David Baker
8fe8bd6a81 Add is_direct to member event spec. 2016-10-03 17:33:45 +01:00