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

1124 commits

Author SHA1 Message Date
Matthew Hodgson e9e3afbd34 clarify who servers should send m.device_list_update EDUs to 2018-09-02 13:00:29 +01:00
Matthew Hodgson 928fc5cbe5 incorporate review 2018-09-01 03:08:53 +01:00
Matthew Hodgson 42b11e096f Review 2018-09-01 02:48:37 +01:00
Matthew Hodgson d25f4412d4 improve wording 2018-09-01 02:46:05 +01:00
Matthew Hodgson db302b66ca revert example which was corect first time; fix rst 2018-09-01 02:44:53 +01:00
Matthew Hodgson 0f9a23c471 swaggerify to-device 2018-09-01 02:37:31 +01:00
Matthew Hodgson 0afdcc59ea spell out stream_id and fix todo 2018-09-01 02:10:45 +01:00
Matthew Hodgson 30d56691b1 document device list synchronisation over federation. 
untested
closes MSC1212
 2018-09-01 01:48:02 +01:00
Travis Ralston 735de03e07 Add r0 version links 
These were missed in the release process.
 2018-08-31 17:40:32 -06:00
Travis Ralston bb2835651f
Merge pull request #1637 from turt2live/travis/c2s/clarify-errors 
List known client-server error codes; Clarify priority of error codes vs http status code
 2018-08-31 16:42:43 -06:00
Travis Ralston 00578547c0
Merge pull request #1644 from matrix-org/rav/is_token_grammar 
Spec grammars for IS things
 2018-08-31 16:05:23 -06:00
Travis Ralston f3825c5827 A couple more stragglers 2018-08-31 15:55:07 -06:00
Travis Ralston 218b86d6e8 Hopefully the last one 2018-08-31 15:48:41 -06:00
Richard van der Hoff 79974b152c s/identity service/identity server 2018-08-31 22:44:36 +01:00
Richard van der Hoff a544b68298 Merge branch 'master' into rav/is_token_grammar 2018-08-31 22:37:04 +01: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
Travis Ralston 835f5de387 Generalize the token name even more 2018-08-31 14:22:07 -06:00
Richard van der Hoff dced3d5707 Notes on the format of IS session IDs and tokens 2018-08-31 21:06:51 +01: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 3146fc339a Merge remote-tracking branch 'matrix-org/master' into travis/c2s/clarify-errors 2018-08-31 11:15:03 -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 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