Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2025-12-22 17:28:38 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
3643 commits 30 branches 42 tags 32 MiB
Commit graph

325 commits

Author SHA1 Message Date
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
Richard van der Hoff ec81b4c9fe More PR feedback 
Add a couple of TODO sections
 2016-08-09 12:16:20 +01:00
Richard van der Hoff 4b0e546eeb PR feedback 
Fix some typos, and clarify several aspects of server behaviour.
 2016-08-09 12:02:38 +01:00
Richard van der Hoff 41368dc5a7 document CAS login 
Following the spirit of "document how it is, not how we wish it was", document
the CAS login bits.
 2016-08-08 17:33:48 +01:00
Richard van der Hoff 49cd65dd58 Add a license to the spec 
We're licensing hte spec under ASLv2. Add the LICENSE file, and add the
short-form to as much of the source as is practical right now (adding it to
json source is a massive pita).
 2016-07-12 17:28:30 +01:00
Richard van der Hoff 885e6797f2 Fix double-negative in room naming 2016-07-12 14:50:49 +01:00
Richard van der Hoff 7b4c21fa77 Add link to room name bug 2016-07-12 11:47:39 +01:00
Richard van der Hoff d4194dd24e Clarify the room-naming behaviour 
Make behaviour on empty `m.room.name` and `m.room.canonical_alias` events
explicit.
 2016-07-11 17:49:27 +01:00
Richard van der Hoff df3f4b4ecf Fix link to draft e2e spec 2016-06-30 18:01:32 +01:00
Mark Haines af091ff614 Document changes to the default push rules 2016-06-22 16:34:23 +01:00
Mark Haines 30a3302921 Merge pull request #274 from matrix-org/markjh/default_rules 
Update the predefined push rules in the spec
 2016-06-22 16:14:21 +01:00
Erik Johnston e80e32173f Merge pull request #278 from matrix-org/erikj/presence 
Update presence spec.
 2016-06-22 14:08:44 +01:00