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

2943 commits

This branch
This branch
All branches
Author SHA1 Message Date
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
ff1afaa8f7 Add a note about how presence lists work 2018-08-17 09:33:17 -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
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
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
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
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
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
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
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
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
Matthew Hodgson
f14640acf2
Merge pull request #1491 from florianjacob/1472-spelling-mistake 
Fix minor spelling mistake in event retrieval endpoints
 2018-08-06 22:08:17 +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
Will Hunt
6dbbe1b838
Merge pull request #1486 from turt2live/travis/words 
Fix wording from bad merge
 2018-08-05 18:34:07 +01:00
Travis Ralston
dcb39f8890 Fix wording from bad merge 2018-08-05 10:55:55 -06:00