Commit Graph

96 Commits

Author SHA1 Message Date
Travis Ralston 465ed38416
Merge pull request from jplatte/event-titles
Make event's title fields UpperCamelCase and distinguish /sync ones
2020-06-19 13:53:52 -06:00
Jonas Platte 763e5654cc
Make event's title fields UpperCamelCase and distinguish /sync ones 2020-06-19 21:53:18 +02:00
Jonas Platte 049275c33b
Consistently use the title UnsignedData for the unsigned object 2020-06-19 20:16:20 +02:00
Travis Ralston db72e7caea
Merge pull request from matrix-org/travis/clarification/send-join
Clarify the auth_chain and state requirements for /send_join
2020-05-26 14:32:48 -06:00
Travis Ralston 67d46fa881 Clarify the auth_chain and state for send_join
Fixes https://github.com/matrix-org/matrix-doc/issues/2467
Fixes https://github.com/matrix-org/matrix-doc/issues/2464

This is based on looking at Synapse, not actually testing it. Within the send_join handling functions, an "event context" is acquired [here](d14c4d6b6d/synapse/handlers/federation.py (L1472)) which then later uses the previous state (populated [here](d14c4d6b6d/synapse/state/__init__.py (L286-L289)) in the event context) [here](d14c4d6b6d/synapse/handlers/federation.py (L1494-L1501)) to return a response. Within the event context, the previous state IDs are populated [here](d14c4d6b6d/synapse/state/__init__.py (L351)).
2020-05-25 11:58:50 -06:00
Travis Ralston 06b0c1762a Move the send_join response to its own definition
Both APIs need clarification, so dedupe the changes.

We should also probably deprecate some of this stuff so we can eventually remove it.
2020-05-25 09:55:32 -06:00
Travis Ralston 36ed6e94a2 Re-introduce signature schemas 2020-05-25 08:16:10 -06:00
Hubert Chathi 5b38c04e19 make definition of signatures fields more consistent 2020-05-22 15:50:32 -04:00
Travis Ralston 42ae5c966a Clarify the limits of prev_events and auth_events
Fixes https://github.com/matrix-org/matrix-doc/issues/2307

These restrictions are due to a Synapse change which never made it to the spec prior to the MSC process. This is therefore documenting an omission.

Synapse's numbers are verified here: 207b1737ee/synapse/handlers/federation.py (L1183-L1213)

... and Synapse's handling of the backfill endpoint is described here: 207b1737ee/synapse/handlers/federation.py (L829-L837)

This also includes a mention that https://github.com/matrix-org/matrix-doc/pull/1594 should render the `auth_events` limitation unnecessary. 

No changes are required to the the "checks on receipt of a PDU" section of the server-server spec as it starts with "must be a valid event", to which an event is invalid if it contains too many prev or auth events.
2020-05-12 19:02:39 -06:00
Gnuxie 6b8b31ce63
correct use of required annotation in json-schema
https://tools.ietf.org/html/draft-handrews-json-schema-validation-02#section-6.5.3
2020-05-06 17:10:39 +01:00
Travis Ralston 6d60258e25
Merge pull request from matrix-org/travis/1.0/msc2076-msc2077-v5-rooms
Spec v5 rooms: Key validity
2019-06-11 08:51:25 -06:00
Travis Ralston cf19f52576 Enforce 7 day validity requirement everywhere
also misc formatting fixes
2019-06-10 13:21:24 -06:00
Travis Ralston 9bf0103ef3 Clarify how many PDUs are in a given transaction object
Fixes https://github.com/matrix-org/matrix-doc/issues/2093
2019-06-06 14:36:30 -06:00
Travis Ralston a6314df44c Spec v5 rooms: Key validity
Proposals:
* [MSC2076](https://github.com/matrix-org/matrix-doc/pull/2076)
* [MSC2077](https://github.com/matrix-org/matrix-doc/pull/2077)

Implementation references:
* 00bf99fa62
* https://github.com/matrix-org/synapse/pull/5354
* https://github.com/matrix-org/synapse/pull/5321

No known differences from the proposals are included here - alterations are accidental.
2019-06-05 17:03:19 -06:00
Travis Ralston 699cafe670 v4 is v4, not v3 2019-05-27 21:27:54 -06:00
Travis Ralston 3b0e194ff7 Add version 4 rooms to the spec
As per [MSC1884](https://github.com/matrix-org/matrix-doc/pull/1884) and [MSC2002](https://github.com/matrix-org/matrix-doc/pull/2002).

No known changes since the proposals were accepted.

Due to being in the area: This fixes https://github.com/matrix-org/matrix-doc/issues/1863
2019-05-24 15:50:05 -06:00
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 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 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 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 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