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

2958 commits

This branch
This branch
All branches
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
8afc82c14b fix /keys/claim request example 
It didn't correspond to the example response.
 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
Valentin Deniaud
ab3272045e add missing v1 to m.olm in /keys/upload 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
c492fe43b5 Add strict typing to the m.receipt EDU; Fix description of event_ids 2018-08-17 09:46:31 -06:00
Travis Ralston
44d1f8dbe5 s/timeline/event graph 2018-08-17 09:46:11 -06:00
Travis Ralston
8ac6cea58b
Merge pull request #1522 from turt2live/travis/c2s/http-push-gw-required-path 
Require the push gateway URL to be of a specific path
 2018-08-17 09:42:17 -06:00
Travis Ralston
49ec0a36a8
Merge pull request #1481 from turt2live/travis/s2s/authentication 
Define authorization requirements on federation swagger APIs
 2018-08-17 09:01:39 -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
5b30d33b89
Simpler language 2018-08-17 02:51:41 -06:00
Travis Ralston
f359b30c6d
Merge pull request #1520 from turt2live/travis/s2s/fix-header 
Fix header in server-server API
 2018-08-16 13:24:33 -06:00
Travis Ralston
c891e4a957 Require the push gateway URL to be of a specific path 2018-08-16 12:39:47 -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
94091a12fb
Merge pull request #1506 from turt2live/travis/general/pushers 
Improve documentation for pushers and push gateways
 2018-08-16 09:23:57 -06:00
Travis Ralston
ae02e8834d changelog 2018-08-15 16:25:04 -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
Travis Ralston
669d526ea7
Merge pull request #1503 from QMatrixClient/support_oneOf 
Support oneOf
 2018-08-13 11:01:51 -06:00
Kitsune Ral
b41eb26124 Document OpenAPI extension 
Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
 2018-08-12 16:52:07 +09:00
Kitsune Ral
9be78f3aa7 Better support enums when they come among oneOf types 2018-08-12 16:45:35 +09:00
Kitsune Ral
88d97b06ae Support oneOf 2018-08-12 16:45:33 +09: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
efb1787391
Merge pull request #1478 from turt2live/travis/s2s/doc-cleanup 
General clean up on the s2s spec
 2018-08-09 12:12:50 -06:00
Travis Ralston
25c77ab2d0 Define authorization requirements on federation swagger APIs 2018-08-09 08:37:35 -06: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
721be47eb1 Describe how get_missing_events actually works 
The original text wasn't far off, except for being wrong about what the fields actually do. This commit also adds a bit of clarity for how the server is expected to behave.
 2018-08-08 08:39:59 -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
57eeddd849 Remove unused origin and destination on EDUs 2018-08-08 07:43:22 -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