Commit Graph

99 Commits

Author SHA1 Message Date
Konstantinos Sideris 192a6c2ab9 Use example.org on examples instead of domain.com which is a real domain
Signed-off-by: Konstantinos Sideris <sideris.konstantin@gmail.com>
2018-09-02 17:58:21 +03:00
Travis Ralston 679ddabb53 Merge remote-tracking branch 'matrix-org/master' into travis/c2s/read-markers 2018-08-31 10:34:19 -06:00
Travis Ralston afa16f1e4e
Merge pull request from turt2live/travis/c2s/room-tags
Update the room tagging documentation
2018-08-31 08:36:40 -06:00
Travis Ralston f923d08078 Add read markers
This is the spec for https://github.com/matrix-org/matrix-doc/issues/910

Fixes https://github.com/matrix-org/matrix-doc/issues/910

Some reverse engineering was required to work out the complete details as to how this works. In particular, the 405 for setting account data and the behaviour of m.read.

References:
* 405 for account data: d69decd5c7/synapse/rest/client/v2_alpha/account_data.py (L85-L90)
* m.read behaviour: d69decd5c7/synapse/rest/client/v2_alpha/read_marker.py (L45-L52)
2018-08-30 16:21:31 -06:00
Travis Ralston 429f302744 Add an `age` to the invite room state example 2018-08-30 13:32:53 -06:00
Travis Ralston 6aacec3178 Fix power level JSON example 2018-08-30 11:40:08 -06:00
Travis Ralston 827033c128 Merge remote matrix-org/master 2018-08-30 11:29:47 -06:00
Travis Ralston fd7cb22a28 Fix event type example of m.forwarded_room_key 2018-08-29 21:22:47 -06:00
Hubert Chathi 4230e375fa
Merge pull request from Zil0/key_sharing
Document key sharing events
2018-08-29 23:05:17 -04:00
Travis Ralston c03f2f8d79 Minor touchups to the room tagging API
Fixes some of https://github.com/matrix-org/matrix-doc/issues/1565
2018-08-29 14:53:55 -06:00
Travis Ralston 26d5a24b88 Merge remote matrix-org/master 2018-08-29 14:17:21 -06:00
Travis Ralston 62b1b8b660 Have unsigned.age appear on all room events
This is useful for a lot of things, like bridges (appservices), VoIP handling, and clients which generally may wish to do something with the field. Might as well include it on every event, despite the recommendation of https://github.com/matrix-org/matrix-doc/issues/1524
2018-08-29 09:32:14 -06:00
Travis Ralston 8e42f3ab3a Fix bad merge on brackets 2018-08-27 19:26:08 -06:00
Travis Ralston 4b05194a91 Fix bad merge 2018-08-27 19:18:14 -06:00
Travis Ralston 4278a9a516 Merge remote-tracking branch 'matrix-org/master' into travis/c2s/fix-events 2018-08-27 19:17:37 -06:00
Travis Ralston e4f8c23972
Merge pull request from turt2live/travis/c2s/html-formatting
Define the supported HTML subset for message events
2018-08-27 19:14:52 -06:00
Travis Ralston ee2ebe6792
Merge pull request from turt2live/travis/c2s/invite-room-state
Move `invite_room_state` to the correct place in the client-server API
2018-08-27 18:47:24 -06:00
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 e5a7dd1c45 Remove excess commas from JSON 2018-08-25 23:00:26 -06:00
Travis Ralston aa294fac06 Define the supported HTML subset for message events
Also clarify that `m.notice` messages can support HTML.

Fixes https://github.com/matrix-org/matrix-doc/issues/1559
Fixes https://github.com/matrix-org/matrix-doc/issues/1560
2018-08-25 22:57:52 -06:00
Travis Ralston 295b1322e2 Add back the unsigned.age property to voip event examples 2018-08-25 22:26:23 -06:00
Travis Ralston 0f28f83270 Fix client-server event schemas: remove `age`, dedupe fields
This commit adds support for event schema examples to have references to help reduce the chance of fields being forgotten. This also helps reduce duplication of fields, allowing for a more consistent spec that uses the same values everywhere.

This also removes both `unsigned` and `age` from the examples as per:
* https://github.com/matrix-org/matrix-doc/issues/1524
* https://github.com/matrix-org/matrix-doc/issues/630

Finally, this replaces "localhost" in the examples with an example domain. This is really just a nitpick thing on my part where seeing a "real world" domain is preferred. 

Fixes https://github.com/matrix-org/matrix-doc/issues/1524
Fixes https://github.com/matrix-org/matrix-doc/issues/630
Step towards https://github.com/matrix-org/matrix-doc/issues/1530
2018-08-24 18:04:51 -06:00
Travis Ralston ef41b5c2bf Server ACLs
Implements the proposal for https://github.com/matrix-org/matrix-doc/issues/1383
2018-08-22 12:48:37 -06:00
Valentin Deniaud 019c290fa2 document m.forwarded_room_key 2018-08-21 21:35:03 +02:00
Valentin Deniaud 2d8a321b46 document key sharing and m.room_key_request 2018-08-21 21:35:03 +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
Michael Telatynski 57571ea4ce
Merge branch 'master' of github.com:matrix-org/matrix-doc into notifications/room 2018-08-16 23:09:59 +01: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
Michael Telatynski 992bc8828a
Merge branches 'master' and 'notifications/room' of github.com:matrix-org/matrix-doc into notifications/room 2018-05-12 09:24:53 +01:00
Michael Telatynski 1e656d836e
spec notifications key on power level event and provide @room in example 2018-04-15 22:35:44 +01:00
Richard Lewis 8d05f80cec Sticker messages (m.sticker) () 2018-03-27 10:00:41 +01: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 eb8c3255bf Remove extraneous comma from m.presence schema
This causes the build to fail. Fixes 

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
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 () 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 ()
* 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
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
David Baker 85bc989c02 pr feedback 2016-10-04 15:07:14 +01:00