Commit graph

1051 commits

Author SHA1 Message Date
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
Travis Ralston 835f5de387 Generalize the token name even more 2018-08-31 14:22:07 -06:00
Travis Ralston f299fe023a English 2018-08-31 12:51:31 -06:00
Travis Ralston f4c5c209f3 Generalize language for pagination
Previously the section was very strict in what pagination was, however this isn't the reality for the matrix specification. Several endpoints have their own pagination naming conventions and do not follow those mandated by this section.

This commit generalizes the language to cover those endpoints while also describing how pagination works. In particular, it describes the rough API shape to expect and how to deal with the responses.

This commit also removes the `M_BAD_PAGINATION` error as it is not used in the real world. Homeservers are instead encouraged to use the standard `M_INVALID_PARAM` or similar error code.

Fixes https://github.com/matrix-org/matrix-doc/issues/610
Fixes https://github.com/matrix-org/matrix-doc/issues/1523
2018-08-31 12:36:08 -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 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 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