Commit graph

2961 commits

Author SHA1 Message Date
Hubert Chathi b45cf4483f providing an alternative to key sharing is currently a non-goal 2018-11-13 21:46:07 -05:00
Hubert Chathi 2dce23564f wording fixes 2018-11-13 21:37:50 -05:00
Hubert Chathi 3918ed3c38 distinguish between retrieving an empty backup and a nonexistent backup 2018-10-30 14:09:40 -04:00
Hubert Chathi 7713a0f402 snake-case for consistency 2018-10-30 10:05:27 -04:00
Hubert Chathi 982abc168a add some examples 2018-10-30 00:12:26 -04:00
Hubert Chathi 7b4b4a2688 fix some English and some minor additions 2018-10-30 00:10:05 -04:00
Hubert Chathi dc0dd18eeb note that version is optional for GET, and say what to do when no keys are found 2018-10-25 13:50:01 -04:00
Hubert Chathi c8eac3ee2d add details on how the encryption is done 2018-10-24 14:48:02 -04:00
Hubert Chathi 9d51d1e8b7 expand the background 2018-10-20 13:45:35 -04:00
Hubert Chathi b45416e8b0 change version from string to integer, plus other minor improvements 2018-10-19 22:19:55 -04:00
Hubert Chathi de5120335f change "string or object" to just "object" 2018-10-11 10:22:42 -04:00
Hubert Chathi 72df5fe436 add details on recovery key format, and some cleanups/fixes 2018-10-10 16:28:24 -04:00
Hubert Chathi 846e9e8fdc add clarifications 2018-09-06 17:52:44 -04:00
Hubert Chathi 8777232987 various clarifications 2018-09-05 23:21:35 -04:00
Hubert Chathi 6e8ba1f7f8 add more details 2018-08-23 23:04:21 -04:00
Hubert Chathi 1b81970a1e initial commit of e2e backup proposal 2018-08-17 22:18:16 -04: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