Commit graph

171 commits

Author SHA1 Message Date
Richard van der Hoff 614680675f
Fix broken links to matrix-doc (#1032)
The spec has moved to https://github.com/matrix-org/matrix-spec, so there were
a lot of broken links here.
2022-04-20 16:36:14 +01:00
Jonas Platte ac9bee3f88
Remove origin from unsigned_pdu_base.yaml (#998)
It doesn't serve a useful purpose, is not enforced to be present by Synapse
and already being omitted by at least one homeserver implementation.
2022-03-29 16:47:56 +01:00
Richard van der Hoff 7293744a5e
Rename changelogs/server_server/3703.clarification to changelogs/server_server/newsfragments/3703.clarification 2022-03-08 15:36:46 +00:00
Travis Ralston e488a7fb6d v1.2 changelog 2022-02-02 10:05:30 -07:00
devonh fc5ba959ca
Separate PDU terms from their definitions (#3527)
Co-authored-by: Andrew Morgan <andrew@amorgan.xyz>
2022-02-01 10:18:42 -05:00
Richard van der Hoff 4a9c236572 Changelogs for #3674 2022-01-26 11:00:30 +00:00
Patrick Cloke fff5f87c3d
Fix the type of children in the /hierarchy S-S API. (#3660)
* Fix the type of children in the /hierarchy S-S API.

* Newsfragment
2022-01-19 13:30:09 -07:00
Travis Ralston 6c4aabd053
Room versions 8 and 9: Restricted rooms (#3387)
* Room versions 8 and 9: Restricted rooms

MSCs:
* https://github.com/matrix-org/matrix-doc/pull/3083
* https://github.com/matrix-org/matrix-doc/pull/3289
* https://github.com/matrix-org/matrix-doc/pull/3375

* Changelogs

* Capitalization

Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>

* Remove verbiage for spaces because they don't exist

* Iterations on text

* Another clarification

* Make error code descriptions consistent

* Apply suggestions from code review

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>

* Incorporate from merge

* Misc language update per review

* Update accuracy before splitting auth rules

* fix wtf moment

* Fix up v8 and v9 to match "fully specify room versions"

* Scope auth events selection to room version

* Apply consistency

* Add changelogs

* Review part 1

* Apply suggestions from code review

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>

* Split out redaction sections

* Clarify general case of join conditions

Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2022-01-18 09:55:34 -07:00
Travis Ralston 9af83dfd41
Add Spaces to the spec (#3610)
* First iteration of specifying Spaces

MSCs:
* https://github.com/matrix-org/matrix-doc/pull/3288
* https://github.com/matrix-org/matrix-doc/pull/2946
* https://github.com/matrix-org/matrix-doc/pull/1772

Note that this makes modifications to the underlying MSCs as well. These are intended to be minor edits to aid clarity/accuracy of the MSCs, as per the proposal process. Functionally, clients and servers might need to change their behaviour slightly as is expected of implementing this stuff early. Synapse has these changes (alongside backwards compatibility) here: https://github.com/matrix-org/synapse/pull/11667

* add changelogs

* Accuracy per review

* Apply suggestions from code review

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>

* fully prefix new endpoints

* Fully prefix endpoint in 3616 too

* Fix ordering example

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2022-01-17 10:03:14 -07:00
Richard van der Hoff 355e06eaa6
Clarification for /event_auth (#3583)
The description on this endpoint implied it returned the auth chain for the
full state of the room, which is incorrect.
2022-01-04 16:45:10 +00:00
Travis Ralston 195b8a54c5 v1.1 changelog 2021-11-09 07:23:27 -07:00
Travis Ralston 8f2e8f03d0
Normalize changelog entries (#3476)
* Remove entries which don't affect the rendered spec (sorry people using the swagger schemas - we'll have to figure out a changelog for you). See https://github.com/matrix-org/matrix-doc/issues/3475
  * Note that a breaking change is removed by this commit: key backup was introduced in this release cycle, so is not breaking.
* Use uniform references to MSCs ("as per MSC0000").
* General rewording to be consistent with the overall voice of the changelog.
* Condensing of entries where needed to make them fit in the changelog.
* Rewording to collapse entries into fewer lines.
* Spell "deprecation" correctly in file extension.
2021-11-05 13:57:39 -06:00
Denis Kasak ed08c1cb9e Tweak PDU diagram demonstrating prev_events. (#3340)
This tweaks the DAG to be simpler, with two linear event chains E4 -> E3
-> E2 -> E1 and E6 -> E5 -> E2 -> E1. The extremities of the DAG are now
the first and only point in the DAG where multiple event parents occur.
Since the point of the diagram is to demonstrate this very situation,
it's better didactically if there is only one such situation in the
diagram.
2021-08-31 16:51:06 +01:00
Niels Basjes cf5b519963 Explain the reasons why <hostname> TLS certificate is needed rather than <delegated_hostname> for SRV delegation. (#3322)
Signed-off-by: Niels Basjes <niels@basjes.nl>
2021-08-27 19:17:17 +01:00
Neil Alexander af0ebc7414 /_matrix/federation/v1/user/devices/{userId}: Rename self_signing_keys to self_signing_key (#3312)
Apparently, in response to a /_matrix/federation/v1/user/devices/{userId} request, Synapse actually returns a key called "self_signing_key" instead of "self_signing_keys".
2021-08-27 19:17:17 +01:00
Hubert Chathi 53fedb2c61 Add changelog 2021-08-27 19:17:14 +01:00
Travis Ralston 2d39ed69c3 Add changelogs 2021-08-27 19:17:12 +01:00
Travis Ralston 5e211480bf add changelog 2021-08-27 19:17:10 +01:00
Travis Ralston 456353c8b4 Add changelogs 2021-08-27 19:17:10 +01:00
Will 415199bd3d
Use Markdown in changelog descriptions 2021-02-02 20:43:14 -08:00
Hubert Chathi f352de90c3
Merge pull request #2536 from uhoreg/cross-signing-spec
initial spec for cross-signing
2020-12-15 13:11:16 -05:00
Travis Ralston e659572183 Add changelogs for 2888 2020-12-07 14:32:58 -07:00
Richard van der Hoff 1b74e96b7e fix RST in changelog 2020-07-16 15:21:50 +01:00
Richard van der Hoff 6da06383e8
Allow /make_join to return a 404 (#2688)
Specify that `GET /_matrix/federation/v1/make_join/{roomId}/{userId}` can
return a 404 if the room is unknown.
2020-07-16 15:17:40 +01:00
Hubert Chathi c8e816d854 Add link to MSC in changelog entries. 2020-06-19 22:22:03 -04:00
Hubert Chathi ec0b9badc7 Merge remote-tracking branch 'origin/master' into cross-signing-spec 2020-05-29 17:25:19 -04:00
Travis Ralston 09986af8fc Server-Server r0.1.4
Includes a link to r0.1.3 because we forgot
2020-05-27 07:21:59 -06:00
Travis Ralston db72e7caea
Merge pull request #2575 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 65c6435093
Merge pull request #2570 from matrix-org/travis/clarification/s2s-auth
Clarify which server names to sign requests with
2020-05-26 12:46:56 -06:00
Travis Ralston 669377888e Fix more typos throughout the specification
Fixes https://github.com/matrix-org/matrix-doc/issues/2193
2020-05-25 12:31:21 -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 b876ac5893 Clarify which server names to sign requests with
Fixes https://github.com/matrix-org/matrix-doc/issues/2512
2020-05-25 08:27:55 -06:00
Travis Ralston 730d164df7 Add changelogs 2020-05-25 08:16:15 -06:00
Travis Ralston 74b627ac0b Fix the response format of the /send endpoint
Fixes https://github.com/matrix-org/matrix-doc/issues/2236
2020-05-20 17:42:15 -06:00
Travis Ralston 3875d50de8 Add missing changelog 2020-05-20 07:50:39 -06:00
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.
2020-05-15 14:10:06 -06:00
Travis Ralston 05228bf40b `s -> s` 2020-05-12 19:13:16 -06:00
Travis Ralston 9599c3bc99 changelog 2020-05-12 19:03:53 -06:00
Hubert Chathi f97b394591 add changelogs 2020-05-12 18:14:56 -04:00
Travis Ralston 3556b8457f Add changelog for 2527 2020-05-11 21:05:26 -06:00
Travis Ralston 97b23da9f6 Update changelog entry for 2510 clarification 2020-04-22 14:27:22 -06:00
Rudi Floren 2bc798dcfa
Add changelog newsfragment 2020-04-22 22:21:36 +02:00
Travis Ralston 4f0ac741a2
Update changelogs/server_server/newsfragments/2470.removal 2020-03-24 11:22:05 -06:00
Patrick Cloke 9944decacf Add changelog entry. 2020-03-24 13:17:22 -04:00
Travis Ralston 912b3cbc95 Move auth events selection to a more appropriate section of the spec
This was pretty buried, and feels like a common question.
2019-12-30 16:29:56 -07:00
Travis Ralston 5cb7599196 Changelog 2019-09-24 13:39:33 -06:00
Travis Ralston 26c2ce8a92 Server-server r0.1.3 changelog 2019-07-30 13:05:32 -06:00
Jimmy Cuadra 5df86dabe0 Clarify the purpose of reference hashes.
The server-server specification describes a "reference hash" of an event
and how to calculate it, but is otherwise not mentioned anywhere else in
the document. This change adds a sentence to explain that they are used
for event identifiers in later room versions, which are described in
other documents.

Signed-off-by: Jimmy Cuadra <jimmy@jimmycuadra.com>
2019-07-09 01:14:29 -07:00
Alexey Andreyev 9ed19a37ad
Client-server: Fix upload keys example request
Contributes to #1733

Signed-off-by: Alexey Andreyev <aa13q@ya.ru>
2019-07-08 22:28:32 +03:00
Travis Ralston 8e6ccf0a0e Federation r0.1.2 2019-06-11 10:38:12 -06:00
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
2019-06-11 09:50:34 -06:00
Travis Ralston 6d60258e25
Merge pull request #2080 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 b7378a860a
Merge pull request #2097 from matrix-org/travis/1.0/common-themes
Specify some of the common concepts for Matrix in the index
2019-06-11 07:51:06 -06:00
Travis Ralston 6a4a6db1bd
Merge pull request #2081 from matrix-org/travis/1.0/pdu-signatures
Clarify which servers are supposed to sign events
2019-06-07 08:56:14 -06:00
Travis Ralston 70da564e2b
Merge pull request #2067 from matrix-org/travis/1.0/stripped-state
Clarify exactly what StrippedState is
2019-06-07 07:12:17 -06:00
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.
2019-06-06 15:59:54 -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 a19eb59f13 Clarify the key object definition for the key management API
Fixes https://github.com/matrix-org/matrix-doc/issues/1907


One too far
2019-06-05 22:09:42 -06:00
Travis Ralston 7ce1ff2135 Clarify which servers are supposed to sign events
Fixes https://github.com/matrix-org/matrix-doc/issues/2074
2019-06-05 20:30:21 -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 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.
2019-06-02 17:41:39 -06:00
Travis Ralston 88d47fd57e Rename changelog entry to point to PR
We use the PR for every other entry, so here is no exception.
2019-05-27 22:51:52 -06:00
Travis Ralston d8eb294906 Fix s2s changelog entries 2019-05-27 22:44:24 -06:00
Travis Ralston 9c2a789d34 Add missing changelogs and make existing ones match conventions
The conventions are not set in stone, however the changelog should not be a mixed bag of voices.
2019-05-23 22:13:57 -06:00
Andrew Morgan 713e4401b4 Add changelogs 2019-05-07 19:54:38 -07:00
Anatoly Sablin 060c5c7b21 Add clarification changelog entry. 2019-02-24 23:01:01 +03:00
Travis Ralston 8bd9ca4edd Prep for r0.1.1 of s2s 2019-02-06 12:39:16 -07:00
Travis Ralston 71f251c733
Merge pull request #1855 from matrix-org/travis/fix-wk-fallback
Fix contradiction in wellknown discovery for servers
2019-02-06 12:22:59 -07:00
Travis Ralston 4b68b5c939 Changelog 2019-02-06 12:20:56 -07:00
Travis Ralston f37a6d2ef5 Changelog 2019-02-04 14:00:34 -07:00
Travis Ralston d370a2c6fd Prepare the identity service and server-server APIs for r0
* Create the changelog scaffolding
* Set up the variables for versioning
2018-08-24 17:19:25 -06:00