Commit Graph

210 Commits (9535540161c2d8c2caf91603716914faec2b8d87)

Author SHA1 Message Date
Travis Ralston db72e7caea
Merge pull request #2575 from matrix-org/travis/clarification/send-join
Clarify the auth_chain and state requirements for /send_join
5 years ago
Travis Ralston 669377888e Fix more typos throughout the specification
Fixes https://github.com/matrix-org/matrix-doc/issues/2193
5 years ago
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)).
5 years ago
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.
5 years ago
Travis Ralston 36ed6e94a2 Re-introduce signature schemas 5 years ago
Hubert Chathi 6a8ba9b1d6 improve description of key object in CS and include a link in Fed 5 years ago
Hubert Chathi 5b38c04e19 make definition of signatures fields more consistent 5 years ago
Travis Ralston 74b627ac0b Fix the response format of the `/send` endpoint
Fixes https://github.com/matrix-org/matrix-doc/issues/2236
5 years ago
Kegsay fc91946e5a
Update api/server-server/backfill.yaml
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
5 years ago
Kegan Dougal 9765116c47 Make backfill wording clearer 5 years ago
Travis Ralston 05e83f2e7d Fix more describes -> describe 5 years ago
Travis Ralston 7c0046ffc7 describes -> describe 5 years ago
Travis Ralston d419e3b38a Remove extraneous spaces 5 years ago
Travis Ralston a2a1694c35 Spec v2 send_join and send_leave endpoints
MSC: https://github.com/matrix-org/matrix-doc/pull/1802

Fixes https://github.com/matrix-org/matrix-doc/issues/2541

This also adds the v2 invite endpoint to the ACL protected list as that appears to be an omission.
5 years ago
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.
5 years ago
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
5 years ago
Patrick Cloke fc03f7faa6 Remove query_auth from the specification per MSC2451. 5 years ago
Travis Ralston 8d865ca53a Add s2s POST /publicRooms per MSC2197
See https://github.com/matrix-org/matrix-doc/pull/2197
5 years ago
Alexey Andreyev 9ed19a37ad
Client-server: Fix upload keys example request
Contributes to #1733

Signed-off-by: Alexey Andreyev <aa13q@ya.ru>
5 years ago
Travis Ralston 8ac555f870
Merge pull request #2083 from matrix-org/travis/1.0/key-object
Clarify the key object definition for the key management API
6 years ago
Travis Ralston 8b7887dfc2 Link to key algorithms section 6 years ago
Travis Ralston 6d60258e25
Merge pull request #2080 from matrix-org/travis/1.0/msc2076-msc2077-v5-rooms
Spec v5 rooms: Key validity
6 years ago
Travis Ralston b7378a860a
Merge pull request #2097 from matrix-org/travis/1.0/common-themes
Specify some of the common concepts for Matrix in the index
6 years ago
Travis Ralston cf19f52576 Enforce 7 day validity requirement everywhere
also misc formatting fixes
6 years ago
Travis Ralston 6d62a1b444
Merge pull request #2084 from matrix-org/travis/1.0/s2s-swagger-touchups
Touchups on the s2s swagger definitions
6 years ago
Travis Ralston 70da564e2b
Merge pull request #2067 from matrix-org/travis/1.0/stripped-state
Clarify exactly what StrippedState is
6 years ago
Travis Ralston b9c9396c11 Specify some of the common concepts for Matrix in the index
See https://github.com/matrix-org/matrix-doc/pull/2061
Fixes https://github.com/matrix-org/matrix-doc/issues/1468
Fixes https://github.com/matrix-org/matrix-doc/issues/1528

The section is not referenced by the specifications yet - they do a fairly good job of explaining it over and over. In future, it would be good to point all the references to the index.
6 years ago
Travis Ralston 9bf0103ef3 Clarify how many PDUs are in a given transaction object
Fixes https://github.com/matrix-org/matrix-doc/issues/2093
6 years ago
Travis Ralston e115e3439d Touchups on the s2s swagger definitions
Duplicate properties, wrong types, etc.
6 years ago
Travis Ralston a19eb59f13 Clarify the key object definition for the key management API
Fixes https://github.com/matrix-org/matrix-doc/issues/1907


One too far
6 years ago
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.
6 years ago
Travis Ralston 0b45f3795b Rename example to invite_room_state
This is a better representation of what it actually is
6 years ago
Travis Ralston 237d585e07 Shorten references to StrippedState in s2s spec 6 years ago
Travis Ralston b9c4a2561f Fix examples of StrippedState in s2s spec 6 years ago
Travis Ralston 7a07a6b358 Clarify exactly what StrippedState is
Fixes https://github.com/matrix-org/matrix-doc/issues/2066

The expectation everywhere is that the `sender` is required. `/initialSync` references StrippedState through a `m.room.member` event reference, and does not need editing.
6 years ago
Travis Ralston 699cafe670 v4 is v4, not v3 6 years ago
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
6 years ago
Andrew Morgan 3c62b90dfb Add missing punctuation 6 years ago
Anatoly Sablin d52918a892 Fix #1904. 6 years ago
Travis Ralston 71f251c733
Merge pull request #1855 from matrix-org/travis/fix-wk-fallback
Fix contradiction in wellknown discovery for servers
6 years ago
Travis Ralston c8428b1f8b Fix contradiction in wellknown discovery for servers
Fixes https://github.com/matrix-org/matrix-doc/issues/1854
6 years ago
Travis Ralston 3dd0601a96 Remove more TLS fingerprint talk 6 years ago
Travis Ralston 222957157f Add missing required flags 6 years ago
Travis Ralston 1d0156ad78 Fix more titles 6 years ago
Travis Ralston 985d02d95e Fix titles in schemas 6 years ago
Travis Ralston 82bed06d3f The event *format* changes, not the version 6 years ago
Travis Ralston 890fb1a019 Fix examples for new schema
Fix missed example in make_join

Fix state array in response of send_join

Try removing examples from send_join?

Try printing more information about the error

Copy/paste known working examples

Try schema definitions in the response?
6 years ago
Travis Ralston 5d8fa65e6e De-duplicate state keys 6 years ago
Travis Ralston 33406e4662 Apply event format warnings to the remainder of the s2s spec 6 years ago
Travis Ralston 9b214ec16d Make the backfill response aware of event format changes 6 years ago