Travis Ralston
1d7ea314d4
Merge pull request #1482 from turt2live/travis/s2s/presence
...
Document how presence EDUs work between servers
2018-08-21 11:26:32 -06:00
Travis Ralston
e500e2502a
Document the maximum value for depth
...
Implements the proposal for https://github.com/matrix-org/matrix-doc/issues/1230
2018-08-21 09:38:01 -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
Travis Ralston
8b65da1cf6
Don't try and be fancy about titles
2018-08-20 11:07:10 -06:00
Travis Ralston
e712466dca
Improve description for currently_active
2018-08-20 10:44:28 -06: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
ab3272045e
add missing v1 to m.olm in /keys/upload
2018-08-18 11:41:45 +02:00
Travis Ralston
5b5b4cfbed
Explicitly say how appservices should detect state events
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1014
2018-08-17 13:38:38 -06:00
Travis Ralston
a4015d5c27
Spelling
2018-08-17 10:58:20 -06:00
Travis Ralston
750d4f9fda
Rename the presence EDU files to be accurate to their types; Misc cleanup of titles
2018-08-17 10:53:47 -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
ebca4c7d86
Merge remote-tracking branch 'matrix-org/master' into travis/s2s/presence
2018-08-17 09:53:57 -06: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
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
96896fe5d6
Add a strict type the m.typing EDU
2018-08-17 09:34:50 -06:00
Travis Ralston
a53fa9300d
Merge remote-tracking branch 'matrix-org/master' into travis/s2s/presence
2018-08-17 09:34:16 -06:00
Travis Ralston
766402a702
Use strict types for the presence EDUs
2018-08-17 09:34:08 -06:00
Travis Ralston
549a25cad9
Add a mention about how currently_active works
...
Reference: d69decd5c7/synapse/handlers/presence.py (L66-L68)
2018-08-17 09:33:40 -06:00
Travis Ralston
e7aed3da26
Remove poll/unpoll from presence
2018-08-17 09:16:39 -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
c891e4a957
Require the push gateway URL to be of a specific path
2018-08-16 12:39:47 -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
Kitsune Ral
b41eb26124
Document OpenAPI extension
...
Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
2018-08-12 16:52:07 +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
25c77ab2d0
Define authorization requirements on federation swagger APIs
2018-08-09 08:37:35 -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
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
05a2427c73
Document how presence EDUs work between servers
...
It's worth noting that Synapse does not make use of the `poll` or `unpoll` fields, and therefore the wording has been updated to permit servers to reject users. In the case of synapse, it would automatically reject everyone in the list by nature of ignoring it.
2018-08-08 08:24:09 -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
Travis Ralston
cfdbee5fc2
EDU origin and destinations aren't required
2018-08-07 14:21:01 -06:00
Travis Ralston
7ada91787a
age_ts isn't real
2018-08-07 14:20:46 -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
8724ed99ad
Merge pull request #1480 from turt2live/travis/s2s/swagger-consumes-json
...
Specify which federation swagger APIs consume JSON
2018-08-07 08:30:34 -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
Travis Ralston
ef9d766dc3
Remove irrelevant TODO
...
We fixed the EDU, so we don't need this comment.
2018-08-03 14:51:46 -06:00