Commit graph

1141 commits

Author SHA1 Message Date
Travis Ralston 9004be7bda Merge remote matrix-org/master 2018-08-31 10:08:05 -06:00
Travis Ralston f013b7ef03
Merge pull request #1631 from turt2live/travis/general/unstable-warning
Render a warning if the spec is unstable
2018-08-31 09:50:37 -06:00
Travis Ralston ab00630ebc Don't include a second unstable warning in the s2s spec for now 2018-08-31 09:49:24 -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 9646d99c9e
Merge pull request #1602 from turt2live/travis/general/redactions
Add the other fields the server is expected to keep on events
2018-08-31 08:31:50 -06:00
Erik Johnston 080845ac1c Add link to previous section 2018-08-31 12:00:38 +01:00
Erik Johnston bbca5ce43a Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/limit_auth_events 2018-08-31 11:52:36 +01:00
Erik Johnston b6ed25e4b4 Fix incorrect indent 2018-08-31 11:32:29 +01:00
Erik Johnston f3a13eed76
Merge pull request #1593 from matrix-org/erikj/auth_events
Update rules on which events to add to `auth_events`
2018-08-31 11:27:03 +01:00
Erik Johnston 86891ca7e4
Merge pull request #1625 from matrix-org/erikj/auth_rejections
Explain how to handle rejected events
2018-08-31 11:26:57 +01:00
Erik Johnston d91dc6fbf6 Fixup 2018-08-31 11:20:26 +01:00
Erik Johnston 4d653748d6 Add note back in 2018-08-31 11:17:58 +01:00
Erik Johnston 8e6c8ba59e Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/spec_3pid_ruls 2018-08-31 11:13:13 +01:00
Erik Johnston a1aedb386a Actually use proper sentences like a proper adult 2018-08-31 11:04:49 +01:00
Erik Johnston 0adfd1ebb0
Merge pull request #1591 from matrix-org/erikj/fixup_auth_rules
Fix up auth rules
2018-08-31 11:01:12 +01:00
Erik Johnston d63184ebac Fixup 2018-08-31 10:59:42 +01:00
Erik Johnston 3c53e1910d Fixup 2018-08-31 10:51:59 +01:00
Erik Johnston 1a45bc4a85 Reword 2018-08-31 10:24:51 +01:00
Erik Johnston 59f86ec8f2 Reindent as RST requires sublists to be three spaces 2018-08-31 10:07:59 +01:00
Erik Johnston f4706c8889 Require creator field 2018-08-31 10:06:26 +01:00
Erik Johnston f3aea32a24 Be consistent with 'If..., reject' 2018-08-31 09:59:45 +01:00
Erik Johnston 6c8a45c165 Full stops 2018-08-31 09:57:00 +01:00
Erik Johnston ebb044674f Remove duplicated explanation about event rejection 2018-08-31 09:51:17 +01:00
Travis Ralston d57b40d0cc Clarify how the client should treat errors
This is based on observation and rough interpretation and may need additional review from people.

Fixes https://github.com/matrix-org/matrix-doc/issues/1188
2018-08-30 23:06:32 -06:00
Travis Ralston e6adf9f6b9 Document known client-server error codes
Covers part of https://github.com/matrix-org/matrix-doc/issues/603 (updating all the endpoints is being done as a separate PR/commit). 

Reference: 74854a9719/synapse/api/errors.py (L30-L61)
2018-08-30 23:05:51 -06:00
Travis Ralston caaa688e37 Fix links to client-server spec 2018-08-30 16:28:26 -06:00
Travis Ralston 219b27b182 Merge remote matrix-org/master 2018-08-30 16:27:20 -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
Richard van der Hoff 0f84c69805
Merge branch 'master' into rav/clarify_event_signing 2018-08-30 22:48:56 +01:00
Travis Ralston 98a445890c Render a warning if the spec is unstable
Fixes https://github.com/matrix-org/matrix-doc/issues/1499

This is done by using magic variables in the RST. The magic variables are generated based on the substitutions available, making them available for use at build-time. 

Magic variables were chosen because it allows people to continue working on the spec and release process without having to worry about removing a chunk of text from the top of the file. Originally, this was attempted by using jinja2 if-statements, however the substitutions are replaced *after* the template is executed, so the condition would never match. 

The format of the variable is to make the templating happy. Using colons or percent signs results in the templator thinking something else is going on, and then complaining about format.
2018-08-30 15:05:50 -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 5e6a2c30a2 Comment out the part where identity services can revoke their keys
They can't because otherwise 3rd party invites can be rejected by homeservers, as per https://github.com/matrix-org/matrix-doc/issues/1633
2018-08-30 15:00:14 -06:00
Travis Ralston cee0a5ac7b
Merge pull request #1557 from turt2live/travis/general/r0-prep
Prepare the identity service and server-server APIs for r0
2018-08-30 14:46:35 -06:00
Travis Ralston 32cde24bcf Fix server-server link in IS spec 2018-08-30 12:26:24 -06:00
Travis Ralston e82c22b060
Merge pull request #1615 from turt2live/travis/is/touchups
Touch up more of the identity service specification
2018-08-30 12:23:25 -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 f09db16027 Merge remote-tracking branch 'matrix-org/master' into travis/s2s/key-mgmt 2018-08-30 12:19:59 -06:00
Travis Ralston 2753d24302 Merge remote-tracking branch 'matrix-org/master' into travis/general/r0-prep 2018-08-30 12:17:09 -06:00
Travis Ralston 440841d1ff Recommend a CSP rather than require it. 2018-08-30 12:13:21 -06:00
Travis Ralston 70f72b5b3b
Merge pull request #1628 from turt2live/travis/as/external_url
Clarify how external_url is supposed to work
2018-08-30 11:12:39 -06:00
Travis Ralston cc1e496287
Merge pull request #1629 from turt2live/travis/as/route-versions
Version all appservice endpoints and provide a fallback
2018-08-30 11:11:25 -06:00
Travis Ralston 326ff6b1a1
Merge branch 'master' into travis/as/external_url 2018-08-30 11:09:15 -06:00
Travis Ralston 0f2e01f5b5
Merge pull request #1555 from turt2live/travis/as/cleanup
Application service spec cleanup; Security definitions; r0 prep
2018-08-30 11:08:10 -06:00
Travis Ralston 1a3f112337 Clarify that the external_url is unsafe 2018-08-30 11:07:09 -06:00
Travis Ralston be5c566028 Version all appservice endpoints and provide a fallback
Fixes https://github.com/matrix-org/matrix-doc/issues/1616
2018-08-30 11:03:42 -06:00
Travis Ralston a48f7b9278 Clarify how external_url is supposed to work
Fixes https://github.com/matrix-org/matrix-doc/issues/1624
2018-08-30 10:49:40 -06:00
Travis Ralston 05b017276c Don't accidentally limit application services to one homeserver 2018-08-30 10:23:12 -06:00
Travis Ralston ab14f33060 Add link to the client-server ACLs module 2018-08-30 10:11:37 -06:00
Erik Johnston 5c2b8e3569 Explain how to handle rejeceted events 2018-08-30 17:03:16 +01:00
Hubert Chathi db644ca522 add some clarifications 2018-08-30 11:24:39 -04:00
Travis Ralston 56f6640c07
Merge pull request #1618 from turt2live/travis/c2s/initalsync
Remove references to initialSync from account data and receipts module
2018-08-30 07:44:08 -06:00
Richard van der Hoff 55c4307f12 Rewrite the section on signing events
... for clarity and de-duplication. And to say a bit about validating the
signatures.
2018-08-30 14:37:24 +01:00
Richard van der Hoff 6ba50fe2f6
Merge pull request #1588 from matrix-org/rav/fix_server_name
Specify that server names cannot be %-encoded
2018-08-30 10:48:06 +01: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
Travis Ralston a5c3924492 Merge remote matrix-org/master 2018-08-29 21:28:24 -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
Travis Ralston dc602b74d2 Reference the server-server specification for /onbind 2018-08-29 21:02:35 -06:00
Travis Ralston 0387da51e2 Clarify how sessions work when establishing associations 2018-08-29 21:02:28 -06:00
Travis Ralston 039cefdbea Say that identity services should be nice to web browsers (CORS/OPTIONS) 2018-08-29 21:02:24 -06:00
Travis Ralston bbba7dedd6 Clean up identity service RST
* Title casing
* s/identity server/identity service
* Rough column limit enforcement
* Add some links (used by future commits)
2018-08-29 21:02:19 -06: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
Hubert Chathi 9b94e588e6 document new state resolution algorithm 2018-08-29 21:39:49 -04:00
Travis Ralston c7a228bf7b Don't make the major version a variable
We are likely to want to maintain v1 when we release a v2, so we'll avoid a variable for now.
2018-08-29 19:32:52 -06:00
Travis Ralston e7a69a6a6d Merge remote-tracking branch 'matrix-org/master' into travis/general/r0-prep 2018-08-29 19:29:42 -06:00
Travis Ralston a46783eb24 Revert "Take out the reference to the current version from the changelog"
This reverts commit 2a20c11467.
2018-08-29 18:10:03 -06:00
Travis Ralston 2a20c11467 Take out the reference to the current version from the changelog 2018-08-29 17:54:48 -06: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
Richard van der Hoff 196159be91 We should include the Host header if the port was explicit. 2018-08-29 22:18:14 +01:00
Travis Ralston abb91508be
Merge pull request #1556 from turt2live/travis/is/cleanup
Identity Service API cleanup
2018-08-29 15:16:53 -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 f2d02c9559 Take out device management section for now
This will be handled by the implementation of https://github.com/matrix-org/matrix-doc/issues/1212
2018-08-29 14:37:30 -06:00
Travis Ralston 8950f0b2cc Spelling 2018-08-29 14:36:43 -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 348b549f9f Add the other fields the server is expected to keep on events
Fixes https://github.com/matrix-org/matrix-doc/issues/839

Reference: d69decd5c7/synapse/events/utils.py (L44-L91)
2018-08-29 11:19:37 -06: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 73feee5d73
Merge pull request #1586 from turt2live/travis/as/comment-ts-section
Comment out the timestamp massaging section for now
2018-08-29 10:10:36 -06:00
Travis Ralston 25b34e1d7b Mention that ts massaging was in a draft, but not in the release 2018-08-29 09:55:43 -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 5019fb7c49
Merge pull request #1359 from uhoreg/well-known
.well-known discovery
2018-08-29 10:40:54 -04:00
Hubert Chathi 688c8ebcd3 specify how to handle multiple olm sessions with the same device 2018-08-29 10:17:20 -04:00
Erik Johnston d921b81c70 Reject events with superfluous auth_events entries 2018-08-29 14:17:52 +01:00
Erik Johnston 073ebb051b Spec third party invites in auth rules 2018-08-29 14:01:07 +01:00
Erik Johnston 5d40af7ecf Update rules on which events to add to auth_events 2018-08-29 13:24:02 +01:00
Erik Johnston 86b5486445 Add missing clauses to and fix authorization rules
They are still missing third party invites.
2018-08-29 11:32:14 +01:00
Erik Johnston 0b7b3bfcb0 Reindent auth rules section
RST expects sub lists to be indented by three or more spaces. By doing
so we can then rely on `#.` for automatic numbering.
2018-08-29 11:20:33 +01:00
Richard van der Hoff d493c82e82 even more clarification 2018-08-29 10:04:02 +01:00
Erik Johnston 7327656965
Merge pull request #1581 from matrix-org/erikj/limit_txn_size
Specify a limit on the number of EDUs and PDUs a transaction can contain
2018-08-29 09:48:57 +01:00
Richard van der Hoff 78d8118846 Further server_name clarification 2018-08-29 09:36:50 +01:00
Richard van der Hoff f15eafae7f Remove trailing spaces 2018-08-29 09:26:31 +01:00
Richard van der Hoff 08fba5de51 Link to grammar rather than duplicating. 2018-08-29 09:25:38 +01:00
Richard van der Hoff 120bb8dc8e s/host/hostname/ 2018-08-29 09:24:24 +01:00
Richard van der Hoff 8679a642b4 clarity 2018-08-29 00:19:05 +01:00
Richard van der Hoff 7f9524f801 s/--/—/ 2018-08-29 00:07:36 +01:00
Richard van der Hoff 6f3b42a457 Server names cannot be %-encoded
They aren't URLs; it was a thinko to refer to the URL spec for this.
2018-08-28 23:56:20 +01:00
Travis Ralston 85b9769cd9 Comment out the timestamp massaging section for now
Pending discussion on https://github.com/matrix-org/matrix-doc/issues/1585
2018-08-28 14:06:55 -06:00
Erik Johnston fc1fdc95af Specify a limit on the number of EDUs and PDUs a transaction can contain 2018-08-28 17:29:58 +01: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 cff5b8b205 More versioned links 2018-08-27 19:30:46 -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 39e674ccb3 Clarify what matrix.to is and mention that room IDs are not routable
Also actually render the warning saying that this scheme is temporary.
2018-08-27 18:27:48 -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 6f80db5ddf Include the "other versions" section of the changelog 2018-08-27 18:04:35 -06:00
Travis Ralston 07153c22a9 Misc. cleanup of the appservice spec 2018-08-27 18:04:19 -06:00
Travis Ralston fa96d8629b Prepare the appservice spec for an r0 release
This puts the scaffolding in place for an r0 release to happen, such as the changelog and version variables.
2018-08-27 18:04:08 -06:00
Travis Ralston 17e0ef4b91 Remove empty file and now-empty section from the appservice spec
This commit has approval under https://github.com/matrix-org/matrix-doc/pull/1555 although is being included in this branch/PR so the build passes, permitting a merge.
2018-08-27 17:58:47 -06:00
Travis Ralston 51193cac39 Merge remote-tracking branch 'matrix-org/master' into travis/as/normal-events 2018-08-27 17:53:32 -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 a0b17e6ed6
Merge pull request #1551 from turt2live/travis/c2s/push-rules
General improvements to the push rules module
2018-08-27 17:48:01 -06:00
Travis Ralston 090f852fdf
Merge pull request #1262 from matrix-org/anoa/document_as_options
Document new application service registration file options
2018-08-27 17:47:53 -06:00
Travis Ralston 54032964fc Misc clarity for 3rd party appservice protocols/locations 2018-08-27 17:41:52 -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 be97e95dc1 Promote device management to be a dedicated section 2018-08-27 14:49:38 -06:00
Travis Ralston 8069981252 Add federation /user/* endpoints
Fixes https://github.com/matrix-org/matrix-doc/issues/1438
2018-08-27 14:19:10 -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 d370a2c6fd Prepare the identity service and server-server APIs for r0
* Create the changelog scaffolding
* Set up the variables for versioning
2018-08-24 17:19:25 -06:00
Travis Ralston dafea96621 Fix indentation and schema references in the identity service spec 2018-08-24 15:53:27 -06:00
Travis Ralston 811998735c Define common error codes in the Identity Service API
Fixes https://github.com/matrix-org/matrix-doc/issues/1407
2018-08-24 15:51:23 -06:00
Travis Ralston 017d6db737 Document third party network/protocol directories (for appservices)
Fixes https://github.com/matrix-org/matrix-doc/issues/869
2018-08-24 11:07:30 -06:00
Travis Ralston 9eda1a6971 Move the third party network API to it's own section 2018-08-24 10:22:19 -06:00
Travis Ralston bbd33c1461 Move appservice transaction API to the right section
Part of https://github.com/matrix-org/matrix-doc/issues/1532
2018-08-23 13:29:04 -06: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
Travis Ralston 3869f68a5c Merge remote-tracking branch 'matrix-org/master' into travis/general/room-versions 2018-08-21 12:22:35 -06:00
Travis Ralston 6172d5986a
Merge pull request #1537 from turt2live/travis/as/user-alias-query
Clean up user and alias querying for application services
2018-08-21 12:14:07 -06:00
Travis Ralston 997562786b
Merge pull request #1534 from turt2live/travis/as/auth-impersonation
Encourage appservices to use the Authorization header
2018-08-21 12:13:35 -06:00
Travis Ralston 1102fc59b2 Spelling 2018-08-21 12:13:19 -06:00
Travis Ralston 389fa87e6e English 2018-08-21 12:10:40 -06:00