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

207 commits

Author SHA1 Message Date
Richard van der Hoff
39b71413be
Update specification/server_server_api.rst 
Co-Authored-By: turt2live <travpc@gmail.com>
 2019-02-01 07:40:39 -07:00
Travis Ralston
1c30f5eba9 Clarify certificate usage and ports 2019-01-31 21:15:47 -07:00
Travis Ralston
3c17a0e53b Mention caching 2019-01-31 16:29:07 -07:00
Travis Ralston
b971bcee7d Accurately represent the 3 proposals and provide more detail 2019-01-31 16:24:07 -07:00
Travis Ralston
d2f012f4ea Incorporate MSC1831 
Original proposal: https://github.com/matrix-org/matrix-doc/pull/1831

Implementation proof: pending
 2019-01-31 11:17:56 -07:00
Travis Ralston
0347e873ef Specify .well-known s2s discovery and X.509 validation 
Original proposals:
* https://github.com/matrix-org/matrix-doc/pull/1708 (note: the JSON requirements were softened by https://github.com/matrix-org/matrix-doc/pull/1824)
* https://github.com/matrix-org/matrix-doc/pull/1711

Implementation proofs:
* https://github.com/matrix-org/synapse/pull/4489
* No explicit PRs for MSC1711 could be found, however Synapse is known to implement it.

There are no intentional changes which differ from the proposals in this commit, however the author has relied upon various historical conversations outside of the proposals to gain the required context. Inaccuracies introduced by the author are purely accidental.
 2019-01-30 22:11:31 -07:00
Travis Ralston
aca9437bf3 Specification for v2 s2s invite API 
Original proposal: https://github.com/matrix-org/matrix-doc/pull/1794
Implementation proofs:
* https://github.com/matrix-org/synapse/pull/4402
* https://github.com/matrix-org/synapse/pull/4496

There are no changes from the original proposal.
 2019-01-28 21:07:00 -07:00
Travis Ralston
061f59547a Minor wording changes 2019-01-23 09:10:14 -07:00
Travis Ralston
166d4ada86 Fix room versions reference in appendices & s2s spec 2019-01-16 17:05:57 -07:00
Travis Ralston
ffe577371d Add a room version specification 
The "Room Specification" (or "Room Version Specification") is the specification that defines which room versions do what and are intended to be documents which speak the truth about how rooms operate under the hood.

The approach taken here is a bit different than other specifications. For starters, the specification is versioned in this project instead of relying on the matrix.org repository to track compiled HTML. This is done for a couple reasons, the first being we're still developing the v1 specification while concurrently making a v2 spec and the second being trying to reduce the reliance on matrix.org's repository for specifications.

Because the room spec is built into versions, some changes needed to be made. The `targets.yaml` now has a special syntax for indicating what version something is at, and the changelog generator can handle rendering different versions of the same changelog (as parsed from the RST). Some additional work has been put in to the changelog parsing to allow us to reference the v1 room spec as "v1" without having to sacrifice clarity in the changelog headings.

Finally, this moves the state resolution algorithms into the versioned
spec as a result of MSC1759 (https://github.com/matrix-org/matrix-doc/pull/1759).

Note: this does not introduce the concept of versioned schemas (tabs) that I was previously working with. There's currently no use for them, so they are shelved elsewhere.
 2019-01-04 15:49:24 -07:00
Erik Johnston
39df8291e9 Add TODO 2018-12-14 13:23:18 +00:00
Erik Johnston
be625254b1 Fix up wording about auth rules to not lie 2018-12-14 13:23:18 +00:00
Erik Johnston
c93bdcc59c Fix up headings 2018-12-14 13:23:18 +00:00
Richard van der Hoff
cac150d567
Fix up wording 
Co-Authored-By: erikjohnston <erikj@jki.re>
 2018-12-14 13:13:06 +00:00
Erik Johnston
ee9c010c37 Document the checks made for incoming PDUs 2018-12-13 14:15:25 +00:00
Erik Johnston
4271391214
Initial stab at documenting soft fail (#1641) 2018-10-26 15:18:04 +01:00
Matthew Hodgson
6dab4b28f8
Merge pull request #1648 from matrix-org/matthew/device_list_update 
document device list synchronisation over federation.
 2018-09-03 16:54:36 +01:00
Matthew Hodgson
334c69bcda wording fix 2018-09-03 16:53:39 +01:00
Matthew Hodgson
ccbc88ee5d reword to spell out to when device list updates should be sent 2018-09-03 16:49:36 +01:00
Matthew Hodgson
bcd48ebbec
Merge pull request #1610 from uhoreg/reloaded 
document new state resolution algorithm
 2018-09-02 23:53:08 +01:00
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
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
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
Richard van der Hoff
0f84c69805
Merge branch 'master' into rav/clarify_event_signing 2018-08-30 22:48:56 +01:00