Commit graph

80 commits

Author SHA1 Message Date
Travis Ralston 82bed06d3f The event *format* changes, not the version 2019-02-01 13:19:24 -07:00
Travis Ralston 33406e4662 Apply event format warnings to the remainder of the s2s spec 2019-02-01 10:08:30 -07:00
Travis Ralston 9b214ec16d Make the backfill response aware of event format changes 2019-02-01 08:40:18 -07:00
Travis Ralston e27c83d9f8
Merge pull request #1817 from matrix-org/neilj/remove_presence_lists
remove references to presence lists
2019-02-01 08:37:08 -07:00
Travis Ralston 41e50d553e
Merge pull request #1830 from matrix-org/travis/spec/x509-wk
Specify .well-known s2s discovery and X.509 validation
2019-02-01 08:36:55 -07:00
Travis Ralston 01556e5b17 Clarifications and bug fixes in how v3 rooms work 2019-01-31 16:44:37 -07:00
Travis Ralston c888f3f080 Make example strings more legible 2019-01-31 00:09:30 -07:00
Travis Ralston 0347e873ef Specify .well-known s2s discovery and X.509 validation
Original proposals:
* https://github.com/matrix-org/matrix-doc/pull/1708 (note: the JSON requirements were softened by https://github.com/matrix-org/matrix-doc/pull/1824)
* https://github.com/matrix-org/matrix-doc/pull/1711

Implementation proofs:
* https://github.com/matrix-org/synapse/pull/4489
* No explicit PRs for MSC1711 could be found, however Synapse is known to implement it.

There are no intentional changes which differ from the proposals in this commit, however the author has relied upon various historical conversations outside of the proposals to gain the required context. Inaccuracies introduced by the author are purely accidental.
2019-01-30 22:11:31 -07:00
Travis Ralston ff75996524 Add specification for room version 3: Event IDs as hashes
Original proposal: https://github.com/matrix-org/matrix-doc/pull/1659
Implementation proofs (some traversing of the PR tree may be required to get all of them):
* https://github.com/matrix-org/synapse/pull/4483
* https://github.com/matrix-org/synapse/pull/4499

This doesn't intentionally change anything from the proposal.

**Implementation details**:

The simple part of this is the introduction of a rooms/v3.html document. The somewhat unclear part is the stuff done to the s2s definitions. This pulls `unsigned_pdu` out to `unsigned_pdu_base` (all fields except `event_id`) where it can be reused in `pdu` and `pdu_v3` (for rooms v3). These definitions are further moved into the room version specifications where they can highlight the exact schemas in detail.

Version 1 has been updated to include the pre-existing event format, however the core principles of the room have not been changed. The same applies to room version 2. Room versions have immutable core principles once in the spec, otherwise these format changes would land in a pre-existing version.

The client-server API event formats will need updating, however that is being punted to a different commit to try and keep these changes reviewable.
2019-01-30 17:03:03 -07:00
Neil Johnson afd399d7d4 remove unused schema defs 2019-01-30 11:43:30 +00:00
Neil Johnson bf2b6e6daa remove references to presence lists 2019-01-28 15:05:10 +00:00
Matthew Hodgson 6dab4b28f8
Merge pull request #1648 from matrix-org/matthew/device_list_update
document device list synchronisation over federation.
2018-09-03 16:54:36 +01:00
Konstantinos Sideris 192a6c2ab9 Use example.org on examples instead of domain.com which is a real domain
Signed-off-by: Konstantinos Sideris <sideris.konstantin@gmail.com>
2018-09-02 17:58:21 +03:00
Matthew Hodgson ee5e519885 device list is 2 words 2018-09-02 13:05:15 +01:00
Matthew Hodgson 928fc5cbe5 incorporate review 2018-09-01 03:08:53 +01:00
Matthew Hodgson 43f2819702 switch to travis' example 2018-09-01 03:06:15 +01:00
Matthew Hodgson 49f0a06238 experiment with additionalProperties some more 2018-09-01 03:03:51 +01:00
Matthew Hodgson f6326030ba backtick asterisk 2018-09-01 03:02:46 +01:00
Matthew Hodgson 7430c3b56f experiment with additionalProperties 2018-09-01 03:01:41 +01:00
Matthew Hodgson 337041610f one slash? 2018-09-01 02:53:15 +01:00
Matthew Hodgson b8608495e9 periods 2018-09-01 02:51:24 +01:00
Matthew Hodgson a842e0433d try escaping the asterisk 2018-09-01 02:50:32 +01:00
Matthew Hodgson 42b11e096f Review 2018-09-01 02:48:37 +01:00
Matthew Hodgson db302b66ca revert example which was corect first time; fix rst 2018-09-01 02:44:53 +01:00
Matthew Hodgson 2c0b45fd14 fix example? 2018-09-01 02:41:53 +01:00
Matthew Hodgson 0f9a23c471 swaggerify to-device 2018-09-01 02:37:31 +01:00
Matthew Hodgson 0ee2cf6286 fix device_list_update example hopefully 2018-09-01 02:14:36 +01:00
Matthew Hodgson d377bedd76 fix path 2018-09-01 01:54:13 +01:00
Matthew Hodgson 30d56691b1 document device list synchronisation over federation.
untested
closes MSC1212
2018-09-01 01:48:02 +01:00
Richard van der Hoff 55c4307f12 Rewrite the section on signing events
... for clarity and de-duplication. And to say a bit about validating the
signatures.
2018-08-30 14:37:24 +01:00
Erik Johnston fc1fdc95af Specify a limit on the number of EDUs and PDUs a transaction can contain 2018-08-28 17:29:58 +01:00
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 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
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
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 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 25c77ab2d0 Define authorization requirements on federation swagger APIs 2018-08-09 08:37:35 -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