Commit graph

869 commits

Author SHA1 Message Date
Travis Ralston 24edec67c3 Merge remote-tracking branch 'matrix-org/master' into anoa/document_as_options 2018-08-21 09:44:04 -06:00
Travis Ralston 06157c6336 Merge branch 'master' into anoa/document_as_options 2018-08-21 09:42:44 -06:00
Travis Ralston 7ad22b2454
Merge pull request #1533 from turt2live/travis/as/general
General/small improvements to the application service API specification
2018-08-20 12:28:38 -06:00
Travis Ralston c8ba2e098c Wording improvements for appservices 2018-08-20 12:09:17 -06:00
Will Hunt fca1c0b7f8
Guests should support /context and /event 2018-08-20 18:06:26 +01:00
Travis Ralston 9ec914956f
Merge pull request #1536 from turt2live/travis/as/user-namespace
Recommend that application services use an underscore for namespacing
2018-08-20 10:16:20 -06:00
Travis Ralston d468ae0fa3
Merge pull request #1535 from turt2live/travis/as/no-sync
Add a note that application services cannot /sync normally
2018-08-20 10:13:11 -06:00
Travis Ralston 26746cf785
Merge pull request #1517 from turt2live/travis/c2s/auth-header
Dedicate a section on how to use access tokens
2018-08-20 10:08:18 -06:00
Valentin Deniaud 9430f2c7f9 room ID is included in Megolm plaintext, not Olm 2018-08-18 11:41:45 +02:00
Valentin Deniaud 8ba19b51ab complete Olm documentation 2018-08-18 11:41:45 +02:00
Valentin Deniaud b2316ba782 enforce unique namespacing in new algorithms experiments 2018-08-18 11:41:45 +02:00
Valentin Deniaud eb8ea0e85a remove warning pointing at outdated doc 2018-08-18 11:41:45 +02:00
Valentin Deniaud 4e0f107ef7 document changed field behavior in e2e sync extension 2018-08-18 11:41:45 +02:00
Valentin Deniaud 248786681e fix typo 2018-08-18 11:41:45 +02:00
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
Travis Ralston 954498bf78 Recommend that application services use an underscore for namespacing
Fixes https://github.com/matrix-org/matrix-doc/issues/689
2018-08-17 15:13:56 -06:00
Travis Ralston 205b326e4a Add a note that application services cannot /sync normally
Fixes https://github.com/matrix-org/matrix-doc/issues/1144
2018-08-17 15:03:30 -06:00
Travis Ralston 7caad61b86 Clearly state how the users namespace relates to interest in events
Fixes https://github.com/matrix-org/matrix-doc/issues/1307
2018-08-17 13:40:05 -06:00
Travis Ralston fd101b6ac9 Misc language changes 2018-08-17 13:39:17 -06: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 d6c54b0278 unaccessible isn't a word 2018-08-15 16:39:01 -06:00
Travis Ralston ca87876f1b Clarify that the Authorization header is preferred 2018-08-15 16:37:52 -06:00
Travis Ralston 25d01aa431 Dedicate a section on how to use access tokens
Fixes https://github.com/matrix-org/matrix-doc/issues/1042.
2018-08-15 16:33:09 -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