Commit Graph

141 Commits (main)

Author SHA1 Message Date
Kévin Commaille dfc8a2e184
Fix `POST _matrix/federation/v1/user/keys/claim` response schema (#1351)
The syntax was not compliant with the Swagger spec.
It also lacked one level of nesting.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2 years ago
Travis Ralston 5f2fac89af Matrix 1.5 2 years ago
Richard van der Hoff 4d0c912acf changelogs 2 years ago
Travis Ralston 7a591366c1 v1.4 changelog 2 years ago
Travis Ralston 227757d499
Threads: Read receipts & notifications (#1255)
* Spec MSC3771: Threaded read receipts

Note: this builds on a (as of writing) non-existent "threading" section, which is part of a different commit.

* Spec MSC3773: Threaded notifications

* changelog

* Various clarifications per review
2 years ago
David Robertson 69ff51c017
Tweak style of `<code>` samples in rendered tables (#1179)
* Tweak style of `<code>` samples in rendered tables

This has been subtly irritating me for aaaaaaages

* Changelogs
2 years ago
Richard van der Hoff b232148821
Clarify the use of JSON in requests and responses (#1185)
Fixes #1182
2 years ago
Richard van der Hoff 5f3b34448d
Add HTML ids for object definitions in the formatted specification (#1174)
* Remove redundant call to resolve-allof

All of the callers to resolve-additional-types already call resolve-allof (or
if not, they should), so this is redundant.

* Update `resolve-additional-types` to take a dict

I want to add more params to this, so first make it take a dict.

* `render-object-table`: take a "title" rather than a "caption"

... which means we can use the result from resolve-additional-types directly.

* render-object-table: support adding an anchor to generated tables.

* resolve-additional-types: generate an id for each returned type

* render-event: pass an anchor_base into resolve-additional-types

This means that it will generate an anchor for each type, whihc will then be
passed into render-object-table and used as an `id` for the table.

* render-operation: pass an anchor_base into resolve-additional-types

* newsfiles
2 years ago
Travis Ralston 98db9a6d04 v1.3 changelog generation 2 years ago
Travis Ralston f14e18131b
Specify room version 10: `knock_restricted` and int power levels (#1099)
* Clarification on historical power level handling

* Revert "Clarification on historical power level handling"

This reverts commit f443b3d5a9.

* Clean up

* Let us try this again not using VS Code

* Markdown is full of mysteries

* Move stringy power levels to room versions

* Describe range

* Fix minor issues with previous room version stuff

* Copy/paste v9 into v10

* Describe deprecated formatting

* Paste unmodified auth rules from v8 into v10

* Move 9.1 to 9.3, add 9.1 and 9.2 for integer enforcement

* Add knock_restricted to v10 auth

* Misc cleanup and clarification for fragments

* Describe `knock_restricted` client changes

* Changelogs

* spelling

* Apply suggestions from code review

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

* Apply code review suggestions manually

* Fix v9 redactions

* Fix auth rules clarity issues

* Apply suggestions from code review

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

* Remove false integer requirements

Co-authored-by: Neil Alexander <neilalexander@users.noreply.github.com>
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2 years ago
Nicolas Werner e70045f4cc
room_type is not a required parameter in practice (#1110)
* room_type is not a required parameter in practice

In practice servers seem to mirror what the room create event does and
leave out the room_type when unset.

Signed-off-by: Nicolas Werner <n.werner@famedly.com>

* Add changelog

Signed-off-by: Nicolas Werner <n.werner@famedly.com>

* Also make room_type and allowed_room_ids optional in the openapi

They are optional according to the text, but the openapi marks them as
required instead.

Signed-off-by: Nicolas Werner <n.werner@famedly.com>

* Fix copy and paste error of newsfragment

Signed-off-by: Nicolas Werner <n.werner@famedly.com>
2 years ago
Travis Ralston 515269b2e3
Unify & standardize the v1.3 changelog (#1102)
* Reference MSCs where MSCs were not being referenced.
* Alter language to appear consistent and from a single voice.
* Bundle and group various changes together (will affect the final changelog - the rendered one still doesn't bundle appropriately).
* Move entries to the spec area they are intended to be in.
2 years ago
Hubert Chathi 2780055198
clarify federation Authorization header an add destination property (#1067)
* clarify federation Authorization header an add destination property

* add changelogs

* some clarifications

* more clarifications, fixes

* use HTML in the added-in/changed-in shortcodes

* Apply suggestions from code review

Co-authored-by: Travis Ralston <travpc@gmail.com>
2 years ago
David Robertson 3f7b0e80a3
Minor drive-by state res clarifications (#1042)
* Opinionated rewrite of unconflicted state map

* Define auth chain
2 years ago
David Robertson c4e54509db
PDU check 5 should consult state before an event (#1070) 2 years ago
Hubert Chathi 58f960e5cc
Merge pull request #1055 from progval/valid_until_ts
Clarify that valid_until_ts is in milliseconds, like other timestamps used in Matrix
2 years ago
David Robertson 9ede29a01d
Attempt to define a valid event (#1045)
* Attempt to define a valid event

Resolves #1044.

Well, maybe.

* Changelog

* link to /rooms, thanks Travis

Co-authored-by: Travis Ralston <travpc@gmail.com>

Co-authored-by: Travis Ralston <travpc@gmail.com>
2 years ago
Valentin Lorentz 34589078fd Clarify that valid_until_ts is in milliseconds, like other timestamps used in Matrix
Signed-off-by: Valentin Lorentz <progval+git@progval.net>
2 years ago
Travis Ralston b6f2b172a6 Clarify that the X-Matrix validation uses the parsed request body (#3727) 2 years ago
Denis Kasak 2857511a02 Changelog 2 years ago
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.
2 years ago
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.
2 years ago
Richard van der Hoff 7293744a5e
Rename changelogs/server_server/3703.clarification to changelogs/server_server/newsfragments/3703.clarification 2 years ago
Travis Ralston e488a7fb6d v1.2 changelog 2 years ago
devonh fc5ba959ca
Separate PDU terms from their definitions (#3527)
Co-authored-by: Andrew Morgan <andrew@amorgan.xyz>
2 years ago
Richard van der Hoff 4a9c236572 Changelogs for #3674 2 years ago
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
2 years ago
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>
2 years ago
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>
2 years ago
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.
2 years ago
Travis Ralston 195b8a54c5 v1.1 changelog 3 years ago
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.
3 years ago
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.
3 years ago
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>
3 years ago
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".
3 years ago
Hubert Chathi 53fedb2c61 Add changelog 3 years ago
Travis Ralston 2d39ed69c3 Add changelogs 3 years ago
Travis Ralston 5e211480bf add changelog 3 years ago
Travis Ralston 456353c8b4 Add changelogs 3 years ago
Will 415199bd3d
Use Markdown in changelog descriptions 3 years ago
Hubert Chathi f352de90c3
Merge pull request #2536 from uhoreg/cross-signing-spec
initial spec for cross-signing
4 years ago
Travis Ralston e659572183 Add changelogs for 2888 4 years ago
Richard van der Hoff 1b74e96b7e fix RST in changelog 4 years ago
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.
4 years ago
Hubert Chathi c8e816d854 Add link to MSC in changelog entries. 4 years ago
Hubert Chathi ec0b9badc7 Merge remote-tracking branch 'origin/master' into cross-signing-spec 4 years ago
Travis Ralston 09986af8fc Server-Server r0.1.4
Includes a link to r0.1.3 because we forgot
4 years ago
Travis Ralston db72e7caea
Merge pull request #2575 from matrix-org/travis/clarification/send-join
Clarify the auth_chain and state requirements for /send_join
4 years ago
Travis Ralston 65c6435093
Merge pull request #2570 from matrix-org/travis/clarification/s2s-auth
Clarify which server names to sign requests with
4 years ago
Travis Ralston 669377888e Fix more typos throughout the specification
Fixes https://github.com/matrix-org/matrix-doc/issues/2193
4 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)).
4 years ago
Travis Ralston b876ac5893 Clarify which server names to sign requests with
Fixes https://github.com/matrix-org/matrix-doc/issues/2512
4 years ago
Travis Ralston 730d164df7 Add changelogs 4 years ago
Travis Ralston 74b627ac0b Fix the response format of the `/send` endpoint
Fixes https://github.com/matrix-org/matrix-doc/issues/2236
4 years ago
Travis Ralston 3875d50de8 Add missing changelog 4 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.
4 years ago
Travis Ralston 05228bf40b ``s -> s`` 4 years ago
Travis Ralston 9599c3bc99 changelog 4 years ago
Hubert Chathi f97b394591 add changelogs 4 years ago
Travis Ralston 3556b8457f Add changelog for 2527 4 years ago
Travis Ralston 97b23da9f6 Update changelog entry for 2510 clarification 4 years ago
Rudi Floren 2bc798dcfa
Add changelog newsfragment 4 years ago
Travis Ralston 4f0ac741a2
Update changelogs/server_server/newsfragments/2470.removal 4 years ago
Patrick Cloke 9944decacf Add changelog entry. 4 years ago
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.
5 years ago
Travis Ralston 5cb7599196 Changelog 5 years ago
Travis Ralston 26c2ce8a92 Server-server r0.1.3 changelog 5 years ago
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>
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 8e6ccf0a0e Federation r0.1.2 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
5 years ago
Travis Ralston 6d60258e25
Merge pull request #2080 from matrix-org/travis/1.0/msc2076-msc2077-v5-rooms
Spec v5 rooms: Key validity
5 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
5 years ago
Travis Ralston 6a4a6db1bd
Merge pull request #2081 from matrix-org/travis/1.0/pdu-signatures
Clarify which servers are supposed to sign events
5 years ago
Travis Ralston 70da564e2b
Merge pull request #2067 from matrix-org/travis/1.0/stripped-state
Clarify exactly what StrippedState is
5 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.
5 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
5 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
5 years ago
Travis Ralston 7ce1ff2135 Clarify which servers are supposed to sign events
Fixes https://github.com/matrix-org/matrix-doc/issues/2074
5 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.
5 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.
5 years ago
Travis Ralston 88d47fd57e Rename changelog entry to point to PR
We use the PR for every other entry, so here is no exception.
5 years ago
Travis Ralston d8eb294906 Fix s2s changelog entries 5 years ago
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.
5 years ago
Andrew Morgan 713e4401b4 Add changelogs 5 years ago
Anatoly Sablin 060c5c7b21 Add clarification changelog entry. 5 years ago
Travis Ralston 8bd9ca4edd Prep for r0.1.1 of s2s 5 years ago
Travis Ralston 71f251c733
Merge pull request #1855 from matrix-org/travis/fix-wk-fallback
Fix contradiction in wellknown discovery for servers
5 years ago
Travis Ralston 4b68b5c939 Changelog 5 years ago
Travis Ralston f37a6d2ef5 Changelog 5 years ago
Travis Ralston d370a2c6fd Prepare the identity service and server-server APIs for r0
* Create the changelog scaffolding
* Set up the variables for versioning
6 years ago