Commit graph

436 commits

Author SHA1 Message Date
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