wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
5313 commits 4 branches 0 tags 17 MiB
Commit graph

1502 commits

Author SHA1 Message Date
Jamie McClymont
d7858354f2 Fix 404s in links from room v1 spec 2019-06-07 20:54:47 +12:00
Travis Ralston
7f01346bba Provide a more complete example of a "minimally-sized event" 
Using all the required fields of a v1 event.
 2019-06-06 23:50:26 -06:00
Travis Ralston
ae9abe798e Revert signature change for redactable event test 
The previous signature was calculated on the unredacted event, which means the signature produced was wrong.
 2019-06-06 23:41:51 -06:00
Travis Ralston
4f665f06e6 Clarify what Matrix 1.0 is further 
And add a table for minimum versions.
 2019-06-06 17:42:37 -06:00
Travis Ralston
06ee60f004 Clarify what compliant implementations are 2019-06-06 17:32:59 -06:00
Travis Ralston
49dbb3ee4f Declare Matrix 1.0 in the index 
Fixes https://github.com/matrix-org/matrix-doc/issues/2044
 2019-06-06 17:26:27 -06:00
Travis Ralston
87d8d97074 Remove incomplete and weird sentence 2019-06-06 17:19:08 -06:00
Travis Ralston
cd6b012523 Clarify what a "module" is and update feature profiles for clients 
Fixes https://github.com/matrix-org/matrix-doc/issues/2009
 2019-06-06 17:07:49 -06:00
Travis Ralston
b9c9396c11 Specify some of the common concepts for Matrix in the index 
See https://github.com/matrix-org/matrix-doc/pull/2061
Fixes https://github.com/matrix-org/matrix-doc/issues/1468
Fixes https://github.com/matrix-org/matrix-doc/issues/1528

The section is not referenced by the specifications yet - they do a fairly good job of explaining it over and over. In future, it would be good to point all the references to the index.
 2019-06-06 15:59:54 -06:00
Travis Ralston
f0eb495cee Clarify how notification counts are calculated in /sync 
Fixes https://github.com/matrix-org/matrix-doc/issues/2015
 2019-06-06 15:41:28 -06:00
Travis Ralston
e644227f4b Clarify that the server shouldn't process retries for UIA 2019-06-06 14:13:20 -06:00
Travis Ralston
e1266b859f
Merge pull request #2030 from matrix-org/travis/1.0/bind-msisdn 
Spec MSISDN UIA support
 2019-06-06 10:24:34 -06:00
Travis Ralston
bbc7401973 Clarify when and where CORS headers should be returned 
Fixes https://github.com/matrix-org/matrix-doc/issues/1736
Fixes https://github.com/matrix-org/matrix-doc/issues/2013
 2019-06-05 23:14:33 -06:00
Travis Ralston
8fd5b15594 Reorganize event structure in c2s spec and clarify event capabilities 
Fixes https://github.com/matrix-org/matrix-doc/issues/1166
Fixes https://github.com/matrix-org/matrix-doc/issues/1527
Fixes https://github.com/matrix-org/matrix-doc/issues/1827

Note: In order to fix the "state events have the following fields: [no words]" bug (1827) we need to resolve references on common event types. When doing this we ultimately end up with more fields than may be required to explain the section, however this commit alters the section descriptions to just say "these fields" instead of "these additional fields".

This is also preferable over trying to get the inheritance reversed in the common event types, as the `/sync` endpoint has a high amount of reliance on partial events definitions.
 2019-06-05 22:55:11 -06:00
Travis Ralston
500f3d3bf1 Clarify that the default s2s transport is JSON over HTTP 
Fixes https://github.com/matrix-org/matrix-doc/issues/1713
 2019-06-05 22:28:57 -06:00
Travis Ralston
80aa5a24dc Make v4 the "default" room version 
As per [MSC2002](https://github.com/matrix-org/matrix-doc/pull/2002). This was missed in https://github.com/matrix-org/matrix-doc/pull/2019

Fixes https://github.com/matrix-org/matrix-doc/issues/2071
 2019-06-05 20:33:09 -06:00
Travis Ralston
7ce1ff2135 Clarify which servers are supposed to sign events 
Fixes https://github.com/matrix-org/matrix-doc/issues/2074
 2019-06-05 20:30:21 -06:00
Travis Ralston
a6314df44c Spec v5 rooms: Key validity 
Proposals:
* [MSC2076](https://github.com/matrix-org/matrix-doc/pull/2076)
* [MSC2077](https://github.com/matrix-org/matrix-doc/pull/2077)

Implementation references:
* 00bf99fa62
* https://github.com/matrix-org/synapse/pull/5354
* https://github.com/matrix-org/synapse/pull/5321

No known differences from the proposals are included here - alterations are accidental.
 2019-06-05 17:03:19 -06:00
Travis Ralston
de725c26cc Add more clarity to the media repo 2019-06-05 10:37:22 -06:00
Travis Ralston
aa110b2be2
Merge pull request #2025 from matrix-org/travis/1.0/3rdpartysigned 
Fix third party signed definitions for join APIs
 2019-06-05 07:10:19 -06:00
Travis Ralston
a3364ff357 Spec SAS verification and the common key verification framework 
Reference implementations:
* 94f664e725
* https://github.com/matrix-org/matrix-react-sdk/pull/2461
* https://github.com/matrix-org/matrix-js-sdk/pull/818
* https://github.com/matrix-org/matrix-react-sdk/pull/2596
* https://github.com/matrix-org/matrix-js-sdk/pull/837

Proposals:
* [MSC1717](https://github.com/matrix-org/matrix-doc/pull/1717)
* [MSC1267](https://github.com/matrix-org/matrix-doc/issues/1267)

No alterations to either proposal have been made intentionally here.
 2019-06-04 12:43:47 -06:00
Travis Ralston
9cb60fa468
Merge pull request #2059 from matrix-org/travis/1.0/msc1719-olm-unwedge 
Add Olm unwedging
 2019-06-04 11:14:54 -06:00
Travis Ralston
39144942da
Fix title ordering 2019-06-03 20:39:41 -06:00
Travis Ralston
1f86e8e31b Refactor documentation for content/media repository 
Fixes https://github.com/matrix-org/matrix-doc/issues/2060
Fixes https://github.com/matrix-org/matrix-doc/issues/772
Fixes https://github.com/matrix-org/matrix-doc/issues/888
 2019-06-02 21:25:11 -06:00
Travis Ralston
57e3b152b0 Move section to under Olm stuff 2019-05-31 11:37:09 -06:00
Travis Ralston
754b19bb92
typo 
Co-Authored-By: Hubert Chathi <hubert@uhoreg.ca>
 2019-05-31 10:21:16 -06:00
Travis Ralston
ff768ec75f
Merge pull request #2036 from matrix-org/travis/1.0/wk-fail-error 
Clarify that FAIL_ERROR is not limited to just homeservers.
 2019-05-30 16:56:28 -06:00
Travis Ralston
54f74cd877 Add Olm unwedging 
As per [MSC1719](https://github.com/matrix-org/matrix-doc/pull/1719)

No known alterations have been made to the proposal.

Implementation proof: https://github.com/matrix-org/matrix-js-sdk/pull/780
 2019-05-30 16:47:30 -06:00
Travis Ralston
0f623113f1 Clarify that UIA stages cannot be attempted twice 
Fixes https://github.com/matrix-org/matrix-doc/issues/1987

Note: Synapse currently does not care, however the spirit of the text in the spec implies that completed == done forever, so we're just reinforcing it here.
 2019-05-29 18:36:10 -06:00
Travis Ralston
41a036a453
Merge pull request #2050 from matrix-org/travis/1.0/clarify-proposals 
Synchronize proposals_intro.rst and CONTRIBUTING.rst
 2019-05-29 18:26:53 -06:00
Travis Ralston
d2232aca97
Merge pull request #2042 from matrix-org/travis/1.0/ordered-flows 
Clarify that login flows must be completed in order
 2019-05-29 16:26:22 -06:00
Travis Ralston
78d93432f4 Synchronize proposals_intro.rst and CONTRIBUTING.rst 2019-05-29 14:00:34 -06:00
Travis Ralston
6706d772c9 Fix test vectors with invalid JSON and signature 
Fixes https://github.com/matrix-org/matrix-doc/issues/2023

The content hashes appear correct, however applying the algorithm defined in the spec never resulted in the signatures previously demonstrated.
 2019-05-29 00:46:00 -06:00
Travis Ralston
3ade2a9ae7 List the endpoints which support LL 2019-05-28 13:57:08 -06:00
Travis Ralston
76829ad988
Merge pull request #2037 from matrix-org/travis/1.0/appservice-hs-token 
Clarify how homeservers are meant to auth themselves to appservices
 2019-05-28 12:56:28 -06:00
Travis Ralston
e2da3728a0 Only error if the token doesn't match 2019-05-28 12:53:48 -06:00
Travis Ralston
a8f61697d1
Merge pull request #2032 from matrix-org/travis/1.0/redaction-effects 
Clarify how redactions affect room state
 2019-05-28 12:52:42 -06:00
Travis Ralston
8151aa331f
Update specification/client_server_api.rst 
Co-Authored-By: Hubert Chathi <hubert@uhoreg.ca>
 2019-05-28 12:51:36 -06:00
Travis Ralston
0580f51206 Clarify that failing to follow the flows == 401 2019-05-28 12:49:50 -06:00
Travis Ralston
4e58414b26 Clarify that clients should not ack their own messages 
Fixes https://github.com/matrix-org/matrix-doc/issues/567
 2019-05-27 23:20:09 -06:00
Travis Ralston
572a6056ad Clarify that login flows must be completed in order 
Fixes https://github.com/matrix-org/matrix-doc/issues/1134

Evidence of this being the case is shown here: https://github.com/matrix-org/synapse/pull/5174
 2019-05-27 23:16:21 -06:00
Travis Ralston
d0fd20fdb4 Clarify how homeservers are meant to auth themselves to appservices 
Fixes https://github.com/matrix-org/matrix-doc/issues/1765

Note that the swagger definitions already say that authorization is required. It just wasn't mentioned in the spec.
 2019-05-27 22:40:07 -06:00
Travis Ralston
10648aa9e8 Clarify that FAIL_ERROR is not limited to just homeservers. 
Fixes https://github.com/matrix-org/matrix-doc/issues/1735
 2019-05-27 22:30:37 -06:00
Travis Ralston
bf8ca3abba
Merge pull request #2026 from matrix-org/travis/1.0/msc1452-server-notices 
Add server notices support
 2019-05-27 21:22:33 -06:00
Travis Ralston
9acd960cf6
Update specification/client_server_api.rst 
Co-Authored-By: Kitsune Ral <Kitsune-Ral@users.sf.net>
 2019-05-27 21:22:07 -06:00
Travis Ralston
ade346f8cc Add m.server_notice to reserved tags 2019-05-27 21:19:58 -06:00
Travis Ralston
d14dc1d8e1 Clarify that redacted state events affect the room with default values 2019-05-27 21:16:02 -06:00
Travis Ralston
8330810e95 Specify the new room naming scheme 2019-05-27 20:47:03 -06:00
Travis Ralston
e610f085a9
Merge pull request #2019 from matrix-org/travis/1.0/msc1884-msc2002-v4-rooms 
Add version 4 rooms to the spec
 2019-05-27 20:08:12 -06:00
Travis Ralston
ba520df004 Move lazy loading to a section in Filtering 2019-05-27 17:38:11 -06:00