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

846 commits

Author SHA1 Message Date
Valentin Deniaud
e5005b2d0f document E2E events 
This was written by Richard van der Hoff.
 2018-08-18 11:41:45 +02:00
Valentin Deniaud
68b78dc5d8 complete Megolm documentation 2018-08-18 11:41:45 +02:00
Valentin Deniaud
669605b24a add Olm missing properties 2018-08-18 11:41:45 +02:00
Valentin Deniaud
76071bae98 explain how to verify sender_key ownership 2018-08-18 11:41:45 +02:00
Valentin Deniaud
8274f91b0b document device verification 
This was written by Richard van der Hoff.
 2018-08-18 11:41:45 +02:00
Valentin Deniaud
a28f243ed7 document left parameter of device_lists in sync response 
fix #1171
 2018-08-18 11:41:45 +02:00
Valentin Deniaud
10c3307427 document device_one_time_keys_count in /sync/ response 
fix #1157
 2018-08-18 11:41:45 +02:00
Valentin Deniaud
2686b99080 fix json indent 2018-08-18 11:41:45 +02:00
Valentin Deniaud
07e3de3c61 add megolm messaging algorithm subsection 
This was written by Richard van der Hoff.
 2018-08-18 11:41:45 +02:00
Valentin Deniaud
33802dbbaf add olm messaging algorithm subsection 
This was written by Richard van der Hoff.
 2018-08-18 11:41:45 +02:00
Valentin Deniaud
e210f8b050 add e2e messaging algorithms section intro 
This was written by Richard van der Hoff.
 2018-08-18 11:41:45 +02:00
Hubert Chathi
f5dc0eaed2
document msisdn-related endpoints in IS (#1507) 
* add msisdn endpoints in Identity Server spec
* add in CS endpoints that use the IS msisdn endpoints
 2018-08-17 12:00:13 -04:00
Travis Ralston
21dc6f823a
Merge pull request #1484 from turt2live/travis/s2s/read-receipts 
Document how read receipts work over federation
 2018-08-17 09:50:40 -06:00
Travis Ralston
44d1f8dbe5 s/timeline/event graph 2018-08-17 09:46:11 -06:00
Travis Ralston
4b9922b641
Merge pull request #1494 from turt2live/travis/general/openid 
Document OpenID in the client-server and server-server APIs
 2018-08-17 08:57:33 -06:00
Travis Ralston
2eab07ade4 Fix header in server-server API 2018-08-16 11:45:53 -06:00
Travis Ralston
2aa0e7b00f
Merge pull request #1483 from turt2live/travis/s2s/typing 
Document how typing notifications work over federation
 2018-08-16 10:09:21 -06:00
Travis Ralston
de961fb7d6 Improve wording on push gateways 2018-08-15 11:59:58 -06:00
Travis Ralston
6ad71f785e Improve documentation for pushers and push gateways 
This fixes a number of formatting issues alongside a few documentation problems:
* The push gateway can actually expect less parameters than previously advertised. This is for user privacy.
* Introduction of the `m.email` pusher for email-capable homeservers.
* Fields not being flagged as required on some endpoints.
* Document the `event_id_only` format

Note: this does not attempt to document push rules, just pushers.

Fixes https://github.com/matrix-org/matrix-doc/issues/1374
Fixes https://github.com/matrix-org/matrix-doc/issues/1087
 2018-08-14 12:51:50 -06:00
Hubert Chathi
cd4fed509c
convert IS endpoints to Swagger (#1427) 2018-08-10 16:21:06 -04:00
Hubert Chathi
292d334509
document new login identifier object (#1390) 2018-08-10 16:19:17 -04:00
Travis Ralston
50fc1c4d16 Move backfill/get events so that joins, leaves, and invites are together 2018-08-09 08:35:24 -06:00
Travis Ralston
83ea90f7ba Move the Authentication section higher in the spec 
It forms the foundation for all the requests under it, so it should appear before the endpoints that need it.
 2018-08-09 08:33:31 -06:00
Travis Ralston
32178bb07e Tidy up the specification 
* Minor word choice changes
* Remove the now-empty "Protocol URLs" section
 2018-08-09 08:33:00 -06:00
Travis Ralston
56dbeeb22a
Merge pull request #1469 from turt2live/travis/s2s/backfill 
Improve documentation for backfilling rooms
 2018-08-09 08:00:43 -06:00
Travis Ralston
c8a8fdfa8d
Merge pull request #1493 from turt2live/travis/s2s/media 
Mention how the content repository works over federation
 2018-08-08 08:30:08 -06:00
Travis Ralston
0a7e670715 Document how typing notifications work over federation 
Relevant synapse code: d69decd5c7/synapse/handlers/typing.py (L221-L230)
 2018-08-08 08:28:52 -06:00
Travis Ralston
e03bfbc47b Document how read receipts work over federation 
Federation format: d69decd5c7/synapse/handlers/receipts.py (L153-L166)

Population of the fields that the above uses to construct the EDU: d69decd5c7/synapse/handlers/receipts.py (L48-L56)
 2018-08-08 08:27:22 -06:00
Travis Ralston
a77975ba68
Merge pull request #1450 from turt2live/travis/s2s/inviting-rooms 
Improve documentation for how non-third party invites work
 2018-08-08 08:19:50 -06:00
Travis Ralston
0f8954d839
Merge pull request #1463 from turt2live/travis/s2s/pdus-and-edus 
Improve documentation around EDUs and PDUs
 2018-08-08 08:02:37 -06:00
Travis Ralston
dcae88c290 Document OpenID in the server-server API 
Part of https://github.com/matrix-org/matrix-doc/issues/857

Reference: d69decd5c7/synapse/federation/transport/server.py (L543-L557)
 2018-08-07 22:13:21 -06:00
Travis Ralston
8ffac01efe Document OpenID in the client-server API 
Part of https://github.com/matrix-org/matrix-doc/issues/857

Reference: d69decd5c7/synapse/rest/client/v2_alpha/openid.py (L31-L58)
 2018-08-07 22:10:11 -06:00
Travis Ralston
cdcd72c0e3 Fix stray hash on client-server API link 
This shouldn't be here, and nothing appears to need it. Removing it now because it has been noticed.
 2018-08-07 17:02:24 -06:00
Travis Ralston
0858e7bd23 Mention how the content repository works over federation 
We might want to consider promoting the media repo to it's own API, and maybe consider calling it the Media Repo rather than Content Repo.

Source of information: experience.
 2018-08-07 16:58:14 -06:00
Travis Ralston
521dcdd5d5 Merge remote-tracking branch 'matrix-org/master' into travis/s2s/backfill 2018-08-07 08:54:25 -06:00
Travis Ralston
35f15ba3d8
Merge pull request #1477 from turt2live/travis/s2s/public-rooms 
Document the /publicRooms endpoint for federation
 2018-08-07 08:31:10 -06:00
Travis Ralston
d712bfc73d
Merge pull request #1479 from turt2live/travis/s2s/server-discovery 
Federation: Document the Host header; Clarify how literal IP addresses are handled
 2018-08-07 08:30:47 -06:00
Travis Ralston
e10770ae8b
Merge pull request #1475 from turt2live/travis/s2s/event-auth 
Document /event_auth and /query_auth
 2018-08-07 08:30:22 -06:00
Richard van der Hoff
eb45419431
Merge pull request #1490 from matrix-org/dbkr/room_tag_grammar 
Fix grammar in room tag spec
 2018-08-07 09:36:28 +01:00
Florian Jacob
e7cebf670e Fix minor spelling mistake from #1472 
Signed-off-by: Florian Jacob <projects+git AT florianjacob )DOT( de>
 2018-08-06 22:59:26 +02:00
David Baker
803ef536ba Fix grammar in room tag spec 
Have removed the second clause about how the client interprets them:
I was trying to think how to rephrase it but I think in reality it's
probably just redundant.
 2018-08-06 15:58:30 +01:00
Travis Ralston
dcb39f8890 Fix wording from bad merge 2018-08-05 10:55:55 -06:00
Will Hunt
c826edf23b Remove dns_name from S2S Api 2018-08-05 14:46:42 +01:00
Will Hunt
7a46bdae02
Spacing 2018-08-05 14:43:05 +01:00
Will Hunt
632101dcde
Merge branch 'master' into hs/dns-to-be-hostname 2018-08-05 14:42:05 +01:00
Travis Ralston
5fbaa1deb5 Federation: Document the Host header; Clarify how literal IP addresses are handled 
Fixes https://github.com/matrix-org/matrix-doc/issues/1161

The IP address clarification is to add an explicit mention of how to handle the case. The prior documentation assumed that all servers would be resolvable with DNS, and does technically have a fallback to use the fallback port, however making it clear feels like a good idea.
 2018-08-03 13:20:46 -06:00
Travis Ralston
2ac80d38d7 Document the /publicRooms endpoint for federation 
This intentionally doesn't document the third party network aspect of the endpoint. This is scheduled for a later area for dealing with third party network/IDs and is reported as https://github.com/matrix-org/matrix-doc/issues/1476

The client-server response has been broken out to a shared file: both the client-server and server-server /publicRoom endpoints return the same thing, with slightly different inputs.

The inputs (and behaviour) are based upon the docstring here: 43ecfe0b10/synapse/federation/transport/server.py (L583-L612)
 2018-08-03 11:23:44 -06:00
Travis Ralston
73958ecbff Document /event_auth and /query_auth 
/event_auth is a fairly easy endpoint to determine the use case of. /query_auth is a little harder to investigate and has a fairly interesting purpose: it appears to be used for the sending server to admit defeat and shop around for the right auth chain, correcting it's own perspective as it goes.

/query_auth is based off the following research points in synapse:
* 43ecfe0b10/synapse/handlers/federation.py (L1947-L1990)
* 43ecfe0b10/synapse/handlers/federation.py (L2049-L2187)
* 43ecfe0b10/synapse/handlers/federation.py (L1716-L1761)
* 43ecfe0b10/synapse/federation/federation_server.py (L393-L446)
* https://github.com/matrix-org/synapse/blob/master/synapse/federation/transport/server.py#L482-L487
 2018-08-03 09:27:19 -06:00
Travis Ralston
6b67d501e4
Merge branch 'master' into travis/s2s/query 2018-08-03 08:55:21 -06:00
Travis Ralston
3a9fb11c9b
Merge branch 'master' into travis/s2s/backfill 2018-08-03 08:54:40 -06:00