Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2025-12-21 08:58:38 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
5313 commits 29 branches 42 tags 32 MiB
Commit graph

436 commits

Author SHA1 Message Date
Neil Johnson c09fa6845e
Update presence.rst 2019-01-29 18:23:30 +00:00
Neil Johnson bf2b6e6daa remove references to presence lists 2019-01-28 15:05:10 +00:00
Travis Ralston 052d68d83d
Merge pull request #1791 from matrix-org/travis/spec/rver-upgrades 
Add room version upgrades
 2019-01-23 19:04:24 -07:00
Travis Ralston 0dfc64a9f4 Improve wording 2019-01-22 18:11:36 -07:00
Travis Ralston 2457438f1e Encourage servers to transfer whatever they can while being open-ended 2019-01-17 13:57:02 -07:00
Travis Ralston 4e0533a5f3 Soften UX requirements 2019-01-17 13:56:48 -07:00
Travis Ralston 82ee3a6035 Adjust wording for SSO introduction 2019-01-17 11:18:48 -07:00
Travis Ralston aeb524ef89 Remove CAS login and reference it against r0.4.0 
The SSO module should cover what CAS provides, and r0.4.0 is good as a reference for how CAS could be implemented without us repeating it here.
 2019-01-16 16:13:53 -07:00
Travis Ralston b85f7bb248 Add room version upgrades 
Implements https://github.com/matrix-org/matrix-doc/issues/1501
 2019-01-09 17:02:09 -07:00
Travis Ralston d6c33ea0a5 Make CAS a subset of SSO 2019-01-09 14:41:46 -07:00
Travis Ralston 3e7a5f5ea4 Initial draft for SSO support 2019-01-09 00:09:38 -07:00
Travis Ralston 35de43de61
Merge pull request #1743 from matrix-org/dbkr/add_sandbox_to_csp 
Add 'sandbox' to recommended CSP header
 2018-12-17 10:28:06 -07:00
J. Ryan Stinnett d197a5761f Clarify encrypted push rules 
Fix `.m.rule.encrypted_room_one_to_one` by moving a condition to the right block
of the rule.

Fix `.m.rule.encrypted` to state that it applies to group rooms.

Signed-off-by: J. Ryan Stinnett <jryans@gmail.com>
 2018-12-11 16:07:01 +00:00
David Baker e318286404 Add 'sandbox' to recommended CSP header 2018-12-10 17:33:04 +00:00
Hubert Chathi 189725659a clarifications and formatting fixes 2018-11-05 15:43:18 -05:00
Hubert Chathi 46fde9723c document megolm session export format 2018-10-19 10:55:14 -04:00
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 218b86d6e8 Hopefully the last one 2018-08-31 15:48:41 -06:00
Travis Ralston 7d34995ece It's actually an "identity server implementing the Identity Service API" 
Also add a note about appservices being special.
 2018-08-31 15:35:32 -06:00
Travis Ralston 7ac76fa27c Actually we're going with "identity server" afterall 2018-08-31 15:04:00 -06:00
Travis Ralston ec248b436f Identity Service is lowercase 2018-08-31 15:04:00 -06:00
Travis Ralston cc0badaaa1 Fix all naming cases of "identity service" 
Fixes https://github.com/matrix-org/matrix-doc/issues/1396

Includes some "homeserver" fixes too. This commit does not include historical documentation or notes.
 2018-08-31 15:04:00 -06:00
Travis Ralston 108c623557
Merge pull request #1635 from turt2live/travis/c2s/read-markers 
Add read markers
 2018-08-31 14:47:39 -06:00
Hubert Chathi c0dd7e0025
Merge pull request #1420 from Zil0/encrypted_attach 
Document encrypted attachments
 2018-08-31 13:33:05 -04:00
Travis Ralston 4b9fb99644 Take out unhelpful example 2018-08-31 11:18:54 -06:00
Travis Ralston f6d9e53f5c Clarify that homeserver must reject clients from setting m.fully_read 2018-08-31 11:13:32 -06:00
Travis Ralston 2e8151999e Clarify that read markers are fully read markers 2018-08-31 11:13:19 -06:00
Hubert Chathi f1f32d3a15 add more clarifications 2018-08-31 12:59:57 -04: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 567843e043 Add additional clarity to how rich replies are structured and used 2018-08-31 10:20:26 -06:00
Hubert Chathi e3daf10bb9 refactor encrypted file schema as "Extension to m.message" 2018-08-31 12:11:27 -04:00
Travis Ralston 9004be7bda Merge remote matrix-org/master 2018-08-31 10:08:05 -06:00
Travis Ralston f72c821be4
Merge pull request #1619 from turt2live/travis/c2s/local-echo 
Reference that transaction IDs may be used to echo
 2018-08-31 09:48:02 -06:00
Travis Ralston 136ba15eb2
Merge pull request #1605 from turt2live/travis/c2s/clarify-html-again 
Mention that clients should not be producing invalid HTML
 2018-08-31 08:41:29 -06:00
Travis Ralston 38ae166e9d
Merge pull request #1505 from turt2live/travis/general/3pid_invite 
Clarify how third party invites work
 2018-08-31 08:38:40 -06:00
Travis Ralston afa16f1e4e
Merge pull request #1606 from turt2live/travis/c2s/room-tags 
Update the room tagging documentation
 2018-08-31 08:36:40 -06:00
Travis Ralston c127eed7e7
Merge pull request #1600 from turt2live/travis/c2s/media-csp 
Specify the minimum CSP for media
 2018-08-31 08:32:33 -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 d57b977a55 Merge branch 'm-master' into travis/general/3pid_invite 2018-08-30 15:01:31 -06:00
Travis Ralston 1f6499d563 Fix typo 2018-08-30 15:01:20 -06:00
Travis Ralston 356626845c Remove unhelpful arrow from the 3rd party invite sequence dance 
This doesn't add anything in terms of clarity.
 2018-08-30 15:00:52 -06:00
Travis Ralston b8f2c721dc Clarify which attributes should be valid 2018-08-30 12:22:50 -06:00
Travis Ralston 2d18b0d2d8 Merge remote-tracking branch 'matrix-org/master' into travis/c2s/clarify-html-again 2018-08-30 12:21:38 -06:00
Travis Ralston 440841d1ff Recommend a CSP rather than require it. 2018-08-30 12:13:21 -06:00
Travis Ralston bd93481013 Reference that transaction IDs may be used to echo 
Fixes https://github.com/matrix-org/matrix-doc/issues/1462
 2018-08-29 23:18:10 -06:00
Travis Ralston 78487a01ec Remove references to initialSync from account data and receipts module 
Fixes https://github.com/matrix-org/matrix-doc/issues/695

Note: This commit leaves the /join endpoints alone because they say "and /sync" rather than just initialSync
 2018-08-29 23:11:00 -06:00
Travis Ralston e227095fb4 Add rich replies 
Fixes https://github.com/matrix-org/matrix-doc/issues/1234

The notable parts of this are:
* The titles go to insane levels. Rich replies are fairly complex and need some splitting apart to be understandable.
* The allowed HTML tags now have an exception for `<mx-reply>`

Please note that the event example is intended to be fixed by a PR that fixes all event examples.
 2018-08-29 22:58:11 -06:00
Hubert Chathi 4230e375fa
Merge pull request #1465 from Zil0/key_sharing 
Document key sharing events
 2018-08-29 23:05:17 -04:00
Hubert Chathi 0130620cc1
Merge pull request #1596 from uhoreg/e2e_sessions 
specify how to handle multiple olm sessions with the same device
 2018-08-29 22:45:38 -04:00
Travis Ralston 2ab2f91088 Merge remote-tracking branch 'matrix-org/master' into travis/releases/push-gateway/r0.1.0 2018-08-29 17:54:34 -06: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 2234e0b097 Mention that clients should not be producing invalid HTML 
Fixes https://github.com/matrix-org/matrix-doc/issues/1595
 2018-08-29 12:38:15 -06:00
Matthew Hodgson 8e88d82a4b fix typo in anchor. fixes #1603 2018-08-29 19:15:05 +01:00
Travis Ralston ec20c43220 Specify the minimum CSP for media 
Fixes https://github.com/matrix-org/matrix-doc/issues/1066
 2018-08-29 10:55:34 -06:00
Travis Ralston 39ef845a53
Merge pull request #1547 from turt2live/travis/c2s/pills 
Document how mentions (pills) work
 2018-08-29 09:13:02 -06:00
Hubert Chathi 688c8ebcd3 specify how to handle multiple olm sessions with the same device 2018-08-29 10:17:20 -04:00
Valentin Deniaud 28ced3b0a4 fixup! document encrypted attachments 2018-08-28 15:04:40 +02:00
Travis Ralston 72c6fa2aaf More versioned links 2018-08-27 19:33:03 -06:00
Travis Ralston e4f8c23972
Merge pull request #1562 from turt2live/travis/c2s/html-formatting 
Define the supported HTML subset for message events
 2018-08-27 19:14:52 -06:00
Travis Ralston fa3e9a7609 Merge remote-tracking branch 'matrix-org/master' into travis/c2s/pills 2018-08-27 18:09:19 -06:00
Travis Ralston 4e885c3f77
Merge pull request #1550 from turt2live/travis/general/acls 
Server ACLs
 2018-08-27 17:48:43 -06:00
Travis Ralston bac0392a2d General clarity for push rule defaults and where to get information 
Include moving a roaming condition that was under the wrong rule.
 2018-08-27 17:28:08 -06:00
Travis Ralston d7397ccd56 Provide additional rationale for kicking users when they are ACLd 2018-08-27 16:21:10 -06:00
Travis Ralston 76afef79f8 Clarify the rationale and motive for blanket IP banning and port exclusion 2018-08-27 16:14:37 -06:00
Travis Ralston 89daa3c5ce Clarify that clients aren't required to render all the tags 
This commit also includes minor clarifications to surrounding text.
 2018-08-27 09:17:40 -06:00
Travis Ralston 5bf99aeb34 Add a note that formatted_body is not forever 2018-08-27 09:17:08 -06:00
Travis Ralston c7822cc9a8 Link to the content repo when referencing MXC URIs in images 2018-08-27 09:16:53 -06:00
Travis Ralston d7d28f7e5b Remove nl as a supported HTML tag 2018-08-27 09:16:30 -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 312799ae78 General clarification for mention and how matrix.to URIs are meant to work 2018-08-25 22:30:49 -06:00
Valentin Deniaud b7577ea237 document encrypted attachments 
Fix #461.
 2018-08-25 17:31:49 +02:00
Valentin Deniaud f6b5aee3e2 explain how to use key sharing events 2018-08-25 17:27:18 +02:00
Travis Ralston ab0be04571 Fix titles 2018-08-22 15:24:53 -06:00
Travis Ralston 7ec3cc4343 General improvements to the push rules module 
This commit does a few things:
* Add 3 undocumented push rules to the spec for encrypted events and at-room notifications.
* Require unrecognized conditions to not match, ensuring that future conditions do not cause clients to accidentally notify users.
* Clarify that push rules should be enabled when created.
* Document a new condition required for at-room notifications.

Fixes https://github.com/matrix-org/matrix-doc/issues/1163
Fixes https://github.com/matrix-org/matrix-doc/issues/1034
Fixes https://github.com/matrix-org/matrix-doc/issues/676
Fixes https://github.com/matrix-org/matrix-doc/issues/1033
Relates to https://github.com/matrix-org/matrix-doc/issues/1101
 2018-08-22 15:21:21 -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
Travis Ralston 9835c98544 Document how mentions (pills) work 
Implements the proposal over at https://github.com/matrix-org/matrix-doc/issues/1067

Includes some specification for how matrix.to is structured, and how it is intended to be replaced.
 2018-08-21 22:05:47 -06:00
Valentin Deniaud 2d8a321b46 document key sharing and m.room_key_request 2018-08-21 21:35:03 +02:00
Will Hunt fca1c0b7f8
Guests should support /context and /event 2018-08-20 18:06:26 +01:00
Valentin Deniaud 9430f2c7f9 room ID is included in Megolm plaintext, not Olm 2018-08-18 11:41:45 +02:00
Valentin Deniaud 8ba19b51ab complete Olm documentation 2018-08-18 11:41:45 +02:00
Valentin Deniaud b2316ba782 enforce unique namespacing in new algorithms experiments 2018-08-18 11:41:45 +02:00
Valentin Deniaud eb8ea0e85a remove warning pointing at outdated doc 2018-08-18 11:41:45 +02:00
Valentin Deniaud 4e0f107ef7 document changed field behavior in e2e sync extension 2018-08-18 11:41:45 +02:00
Valentin Deniaud 248786681e fix typo 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
Valentin Deniaud 68b78dc5d8 complete Megolm documentation 2018-08-18 11:41:45 +02:00
Valentin Deniaud 669605b24a add Olm missing properties 2018-08-18 11:41:45 +02:00
Valentin Deniaud 76071bae98 explain how to verify sender_key ownership 2018-08-18 11:41:45 +02:00
Valentin Deniaud 8274f91b0b document device verification 
This was written by Richard van der Hoff.
 2018-08-18 11:41:45 +02:00
Valentin Deniaud a28f243ed7 document left parameter of device_lists in sync response 
fix #1171
 2018-08-18 11:41:45 +02:00
Valentin Deniaud 10c3307427 document device_one_time_keys_count in /sync/ response 
fix #1157
 2018-08-18 11:41:45 +02:00
Valentin Deniaud 2686b99080 fix json indent 2018-08-18 11:41:45 +02:00
Valentin Deniaud 07e3de3c61 add megolm messaging algorithm subsection 
This was written by Richard van der Hoff.
 2018-08-18 11:41:45 +02:00
Valentin Deniaud 33802dbbaf add olm messaging algorithm subsection 
This was written by Richard van der Hoff.
 2018-08-18 11:41:45 +02:00
Valentin Deniaud e210f8b050 add e2e messaging algorithms section intro 
This was written by Richard van der Hoff.
 2018-08-18 11:41:45 +02:00
Travis Ralston 4b9922b641
Merge pull request #1494 from turt2live/travis/general/openid 
Document OpenID in the client-server and server-server APIs
 2018-08-17 08:57:33 -06:00
Travis Ralston de961fb7d6 Improve wording on push gateways 2018-08-15 11:59:58 -06:00
Travis Ralston 6ad71f785e Improve documentation for pushers and push gateways 
This fixes a number of formatting issues alongside a few documentation problems:
* The push gateway can actually expect less parameters than previously advertised. This is for user privacy.
* Introduction of the `m.email` pusher for email-capable homeservers.
* Fields not being flagged as required on some endpoints.
* Document the `event_id_only` format

Note: this does not attempt to document push rules, just pushers.

Fixes https://github.com/matrix-org/matrix-doc/issues/1374
Fixes https://github.com/matrix-org/matrix-doc/issues/1087
 2018-08-14 12:51:50 -06:00
Travis Ralston 88b35d1be5 Clarify how third party invites work 
This adds several diagrams to the Client-Server API about how invites
are handled, including what the server is expected to do. This helps
implementors know what they are supposed to do in the common cases,
and infer where needed to get the more complex cases correct.

Although lacking in some areas, this is how third party invites work
today.

A link to the now-improved client-server documentation for third party
invites has been added to the server-server specification. The existing
server-server specification needed no further changes on the subject.

Fixes https://github.com/matrix-org/matrix-doc/issues/1366
 2018-08-13 16:29:50 -06:00
Travis Ralston 8ffac01efe Document OpenID in the client-server API 
Part of https://github.com/matrix-org/matrix-doc/issues/857

Reference: d69decd5c7/synapse/rest/client/v2_alpha/openid.py (L31-L58)
 2018-08-07 22:10:11 -06:00
David Baker 803ef536ba Fix grammar in room tag spec 
Have removed the second clause about how the client interprets them:
I was trying to think how to rephrase it but I think in reality it's
probably just redundant.
 2018-08-06 15:58:30 +01:00
David Baker 2dc51d416d Ignore stuff in m. you don't understand 2018-07-27 12:27:30 +01:00
David Baker f90ed4b77d Make non-namespaced tags verboten 2018-07-27 12:08:04 +01:00
David Baker e4fd088fcc Fix room tags spec 2018-07-27 12:05:30 +01:00
Ben Parsons 07aeaadef9 update links which used to point to docs/spec/intro 2018-07-24 11:41:03 +01:00
Andrew Morgan 291a4dfc76 Third party lookup module. Fix wording 2018-07-12 16:59:30 +01:00
Andrew Morgan 114bcf1a2e Use $ref, clean up, fix errors, AS is now a C-S module. 2018-07-12 14:31:34 +01:00
Travis Ralston 9037f506ac Document how to report content 
Fixes: https://github.com/matrix-org/matrix-doc/issues/739

Signed-off-by: Travis Ralston <travpc@gmail.com>
 2018-05-27 12:19:30 -06:00
Jason Volk 2a6895e759 Fix typo. 2018-05-18 17:06:22 -07:00
Jason Volk 2802fdea7e Fix typo. 2018-04-24 19:29:00 -07:00
Richard Lewis 8d05f80cec Sticker messages (m.sticker) (#1158) 2018-03-27 10:00:41 +01: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 d37ed0876f
Merge branch 'master' into travis/m.ignored_user_list 2018-03-05 14:52:37 -07: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
Florian Jacob ac861d9b97 Correct CAS spec link 
Signed-off-by: Florian Jacob <projects+git AT florianjacob )DOT( de>
 2017-11-16 13:44:50 +01:00
Victor Berger cc8128edad
Specify namespaces for tags 
This is a proposition for closing #931.

This should be a fairly uncontroversial addition (apart from bike-shedding), which only defines behavior for clients that want use tags or expose tagging functionality to their users.

The idea of adding this to the spec is to ensure clients can peacefully share the tag namespace without conflicting with each other, using rules similar to namespaces for state keys.
 2017-11-03 17:03:37 +01:00
Travis Ralston 5e7df0e87c Update instant_messaging.rst 
Signed-off-by: Travis Ralston <travpc@gmail.com>
 2017-10-17 09:08:50 -06:00
Richard van der Hoff da6938b818 Key management APIs (#894) 
Spec the e2e key-management APIs.
 2017-04-20 16:51:42 +01:00
Richard van der Hoff 5537f7a832 Allow guest access to E2E endpoints 2016-11-30 16:12:17 +00:00
Richard van der Hoff 4abdcc6f05 Merge pull request #402 from matrix-org/rav/device_management 
Device management API
 2016-11-09 15:09:46 +00:00
Richard van der Hoff 461bfdb0d8 Merge branch 'master' into rav/device_management 2016-11-09 14:34:04 +00:00
Mark Haines 7025793ca8 Say that thumbnails should be 'mxc://' 2016-11-07 16:17:25 +00:00
David Baker 41f4661d1b Fix API path in pushrules examples 2016-10-13 15:14:29 +01:00
Richard van der Hoff af515012ea Device management API 2016-10-12 17:26:01 +01:00
Richard van der Hoff 42616f839c Merge pull request #396 from matrix-org/dbkr/notifs_api 
Spec notifs API
 2016-10-06 17:21:47 +01:00
Richard van der Hoff 909aef2b18 Merge pull request #389 from matrix-org/erikj/create_room_is_direct 
Spec /createRoom is_direct flag, is_direct in member event and m.direct
 2016-10-06 17:19:48 +01:00
Richard van der Hoff 83b89aa1ce dm: clarify client behaviour 2016-10-06 17:17:35 +01:00
David Baker ed2d364440 consistency 2016-10-06 11:17:43 +01:00
David Baker 96b6fb0129 'In the m.room.member' event 2016-10-06 11:16:56 +01:00
David Baker 301595c071 Linkify account_data API 
Also change other links because it turns out the .. isn't part
of the syntax
 2016-10-06 11:15:44 +01:00
David Baker 2a987c3369 Linkify endpoints properly 2016-10-05 18:19:17 +01:00
David Baker 2259a00ba2 links 2016-10-05 13:29:43 +01:00
David Baker 3f66ba713c Reference m.room.member section 2016-10-05 13:25:42 +01:00
David Baker e2024e5829 Add note on how to use the account data event 2016-10-05 13:22:30 +01:00
David Baker d791f35007 Remove unnecessary paragraph 2016-10-05 13:13:50 +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 c16ba9488f Spec notifs API 2016-10-05 10:15:49 +01:00
David Baker 8e096bdc48 Link to createRoom, not initialsync 2016-10-04 15:15:01 +01:00
David Baker 85bc989c02 pr feedback 2016-10-04 15:07:14 +01:00
David Baker 976d41351e spelling 2016-10-04 12:43:41 +01:00
David Baker d39f662df5 PR feedback 2016-10-04 11:57:24 +01:00
David Baker 203ea99328 Spec m.direct 2016-10-03 18:17:43 +01:00
Richard van der Hoff ebaaa7e3b3 Review feedback 
* store-and-forward -> send-to-device
* describe motivation
* device ids are 10 capital chars
* etc
 2016-09-29 13:18:45 +01:00
Richard van der Hoff ccd7bb32d5 Specification for direct-to-device messages 2016-09-27 14:27:27 +01:00
David Baker 9a1db01d92 Clarify highlight and sound tweaks. 2016-09-08 11:59:49 +01:00
David Baker fd888fcbda Merge pull request #373 from matrix-org/dbkr/contains_display_name_override 
Make the display name rule an override rule
 2016-08-17 09:43:44 +01:00
David Baker b65b0d049e Make the display name rule an override rule 2016-08-15 18:32:35 +01:00
David Baker 6592646ee9 Add dot prefix to .rule.master 
It's a default rule, so it needs a dot
 2016-08-15 18:29:39 +01:00
Richard van der Hoff 1f1dfdd91c More clarifications 2016-08-09 15:51:12 +01:00