From 8f2e8f03d0c09676c105f491cdb5bd838b11ba77 Mon Sep 17 00:00:00 2001 From: Travis Ralston Date: Fri, 5 Nov 2021 13:57:39 -0600 Subject: [PATCH] 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. --- changelogs/client_server/newsfragments/2387.new | 2 +- changelogs/client_server/newsfragments/2536.feature | 2 +- changelogs/client_server/newsfragments/2536.new | 2 +- changelogs/client_server/newsfragments/2597.feature | 2 +- changelogs/client_server/newsfragments/2609.removal | 2 +- .../client_server/newsfragments/2629.clarification | 2 +- .../client_server/newsfragments/2634.clarification | 2 +- .../client_server/newsfragments/2639.clarification | 1 - changelogs/client_server/newsfragments/2639.new | 1 + .../client_server/newsfragments/2647.clarification | 2 +- .../client_server/newsfragments/2653.clarification | 2 +- .../client_server/newsfragments/2669.clarification | 2 +- .../client_server/newsfragments/2670.clarification | 2 +- changelogs/client_server/newsfragments/2687.breaking | 2 +- changelogs/client_server/newsfragments/2709.feature | 2 +- changelogs/client_server/newsfragments/2807.feature | 2 +- changelogs/client_server/newsfragments/2808.feature | 2 +- .../client_server/newsfragments/2814.clarification | 2 +- .../client_server/newsfragments/3091.clarification | 2 +- changelogs/client_server/newsfragments/3098.feature | 2 +- changelogs/client_server/newsfragments/3149.feature | 2 +- changelogs/client_server/newsfragments/3151.feature | 2 +- changelogs/client_server/newsfragments/3163.new | 2 +- .../{3199.deprecaation => 3199.deprecation} | 0 changelogs/client_server/newsfragments/3327.breaking | 1 - .../client_server/newsfragments/3330.clarification | 2 +- .../client_server/newsfragments/3331.clarification | 2 +- .../client_server/newsfragments/3336.clarification | 1 - changelogs/server_server/newsfragments/2536.feature | 10 +--------- 29 files changed, 25 insertions(+), 35 deletions(-) delete mode 100644 changelogs/client_server/newsfragments/2639.clarification create mode 100644 changelogs/client_server/newsfragments/2639.new rename changelogs/client_server/newsfragments/{3199.deprecaation => 3199.deprecation} (100%) delete mode 100644 changelogs/client_server/newsfragments/3327.breaking delete mode 100644 changelogs/client_server/newsfragments/3336.clarification diff --git a/changelogs/client_server/newsfragments/2387.new b/changelogs/client_server/newsfragments/2387.new index cfb5af1c..ab8b151e 100644 --- a/changelogs/client_server/newsfragments/2387.new +++ b/changelogs/client_server/newsfragments/2387.new @@ -1 +1 @@ -Add key backup (`/room_keys/*`) endpoints. +Add key backup (`/room_keys/*`) endpoints as per [MSC1219](https://github.com/matrix-org/matrix-doc/pull/1219). diff --git a/changelogs/client_server/newsfragments/2536.feature b/changelogs/client_server/newsfragments/2536.feature index 56e4e79b..c9cfadb4 100644 --- a/changelogs/client_server/newsfragments/2536.feature +++ b/changelogs/client_server/newsfragments/2536.feature @@ -1 +1 @@ -Add cross-signing properties to the response of `POST /keys/query` per [MSC1756](https://github.com/matrix-org/matrix-doc/pull/1756). +Add cross-signing properties to the response of `POST /keys/query` as per [MSC1756](https://github.com/matrix-org/matrix-doc/pull/1756). diff --git a/changelogs/client_server/newsfragments/2536.new b/changelogs/client_server/newsfragments/2536.new index 8572e33a..dad16ec8 100644 --- a/changelogs/client_server/newsfragments/2536.new +++ b/changelogs/client_server/newsfragments/2536.new @@ -1 +1 @@ -Add `POST /keys/device_signing/upload` and `POST /keys/signatures/upload` per [MSC1756](https://github.com/matrix-org/matrix-doc/pull/1756). +Add `POST /keys/device_signing/upload` and `POST /keys/signatures/upload` as per [MSC1756](https://github.com/matrix-org/matrix-doc/pull/1756). diff --git a/changelogs/client_server/newsfragments/2597.feature b/changelogs/client_server/newsfragments/2597.feature index 833006a9..cc08a166 100644 --- a/changelogs/client_server/newsfragments/2597.feature +++ b/changelogs/client_server/newsfragments/2597.feature @@ -1 +1 @@ -Document Secure Secret Storage and Sharing (MSC1946/2472). +Document Secure Secret Storage and Sharing as per [MSC1946](https://github.com/matrix-org/matrix-doc/pull/1946) and [MSC2472](https://github.com/matrix-org/matrix-doc/pull/2472). diff --git a/changelogs/client_server/newsfragments/2609.removal b/changelogs/client_server/newsfragments/2609.removal index 24b523e9..2d203c51 100644 --- a/changelogs/client_server/newsfragments/2609.removal +++ b/changelogs/client_server/newsfragments/2609.removal @@ -1 +1 @@ -Remove unimplemented `m.login.oauth2` and `m.login.token` user-interactive authentication mechanisms. +Remove unimplemented `m.login.oauth2` and `m.login.token` user-interactive authentication mechanisms as per [MSC2610](https://github.com/matrix-org/matrix-doc/pull/2610) and [MSC2611](https://github.com/matrix-org/matrix-doc/pull/2611). diff --git a/changelogs/client_server/newsfragments/2629.clarification b/changelogs/client_server/newsfragments/2629.clarification index 0813de44..afb05a5c 100644 --- a/changelogs/client_server/newsfragments/2629.clarification +++ b/changelogs/client_server/newsfragments/2629.clarification @@ -1 +1 @@ -Remove `room_id` from `/sync` examples. +Remove spurious `room_id` from `/sync` examples. diff --git a/changelogs/client_server/newsfragments/2634.clarification b/changelogs/client_server/newsfragments/2634.clarification index 64d9f142..52a7737c 100644 --- a/changelogs/client_server/newsfragments/2634.clarification +++ b/changelogs/client_server/newsfragments/2634.clarification @@ -1 +1 @@ -Minor clarifications to the "Push Notifications" module. +Reorganize information in Push Notifications module for clarity. diff --git a/changelogs/client_server/newsfragments/2639.clarification b/changelogs/client_server/newsfragments/2639.clarification deleted file mode 100644 index 7d7032ba..00000000 --- a/changelogs/client_server/newsfragments/2639.clarification +++ /dev/null @@ -1 +0,0 @@ -Fixed some errors in the key backup spec. \ No newline at end of file diff --git a/changelogs/client_server/newsfragments/2639.new b/changelogs/client_server/newsfragments/2639.new new file mode 100644 index 00000000..ab8b151e --- /dev/null +++ b/changelogs/client_server/newsfragments/2639.new @@ -0,0 +1 @@ +Add key backup (`/room_keys/*`) endpoints as per [MSC1219](https://github.com/matrix-org/matrix-doc/pull/1219). diff --git a/changelogs/client_server/newsfragments/2647.clarification b/changelogs/client_server/newsfragments/2647.clarification index e902980e..9769bfbf 100644 --- a/changelogs/client_server/newsfragments/2647.clarification +++ b/changelogs/client_server/newsfragments/2647.clarification @@ -1 +1 @@ -Improve consistency and clarity of event schema `title` s. +Improve consistency and clarity of event schema `title`s. diff --git a/changelogs/client_server/newsfragments/2653.clarification b/changelogs/client_server/newsfragments/2653.clarification index 4476d8b3..24252618 100644 --- a/changelogs/client_server/newsfragments/2653.clarification +++ b/changelogs/client_server/newsfragments/2653.clarification @@ -1 +1 @@ -Fix some errors in the end-to-end encryption spec. +Fix schema issues in `m.key.verification.accept` and secret storage. diff --git a/changelogs/client_server/newsfragments/2669.clarification b/changelogs/client_server/newsfragments/2669.clarification index 0e219bfc..9efbea5d 100644 --- a/changelogs/client_server/newsfragments/2669.clarification +++ b/changelogs/client_server/newsfragments/2669.clarification @@ -1 +1 @@ -Fix types of push rules' actions; they can be objects as well as strings. +Fix schemas for push rule actions to represent their alternative object form. diff --git a/changelogs/client_server/newsfragments/2670.clarification b/changelogs/client_server/newsfragments/2670.clarification index 64d9f142..0b1e6e7a 100644 --- a/changelogs/client_server/newsfragments/2670.clarification +++ b/changelogs/client_server/newsfragments/2670.clarification @@ -1 +1 @@ -Minor clarifications to the "Push Notifications" module. +Fix usage of `highlight` tweak for consistency. diff --git a/changelogs/client_server/newsfragments/2687.breaking b/changelogs/client_server/newsfragments/2687.breaking index c40f7625..a5e41517 100644 --- a/changelogs/client_server/newsfragments/2687.breaking +++ b/changelogs/client_server/newsfragments/2687.breaking @@ -1 +1 @@ -Document `curve25519-hkdf-sha256` key agreement method for SAS verification, and deprecate old method (MSC2630). +Document `curve25519-hkdf-sha256` key agreement method for SAS verification, and deprecate old method as per [MSC2630](https://github.com/matrix-org/matrix-doc/pull/2630). diff --git a/changelogs/client_server/newsfragments/2709.feature b/changelogs/client_server/newsfragments/2709.feature index 309b1c0d..1107e31c 100644 --- a/changelogs/client_server/newsfragments/2709.feature +++ b/changelogs/client_server/newsfragments/2709.feature @@ -1 +1 @@ -Add a `device_id` parameter to login fallback per [MSC2604](https://github.com/matrix-org/matrix-doc/pull/2604). +Add a `device_id` parameter to login fallback as per [MSC2604](https://github.com/matrix-org/matrix-doc/pull/2604). diff --git a/changelogs/client_server/newsfragments/2807.feature b/changelogs/client_server/newsfragments/2807.feature index 6a34b60f..088e7c1c 100644 --- a/changelogs/client_server/newsfragments/2807.feature +++ b/changelogs/client_server/newsfragments/2807.feature @@ -1 +1 @@ -Make `reason` and `score` parameters optional in the content reporting API (MSC2414). +Make `reason` and `score` parameters optional in the content reporting API as per [MSC2414](https://github.com/matrix-org/matrix-doc/pull/2414). diff --git a/changelogs/client_server/newsfragments/2808.feature b/changelogs/client_server/newsfragments/2808.feature index 3c97b84f..a98ea6aa 100644 --- a/changelogs/client_server/newsfragments/2808.feature +++ b/changelogs/client_server/newsfragments/2808.feature @@ -1 +1 @@ -Allow guests to get the list of members for a room (MSC2689). +Allow guests to get the list of members for a room as per [MSC2689](https://github.com/matrix-org/matrix-doc/pull/2689). diff --git a/changelogs/client_server/newsfragments/2814.clarification b/changelogs/client_server/newsfragments/2814.clarification index 840300fe..01b500b3 100644 --- a/changelogs/client_server/newsfragments/2814.clarification +++ b/changelogs/client_server/newsfragments/2814.clarification @@ -1 +1 @@ -Clarify description of m.room.redaction event. +Clarify description of `m.room.redaction` event. diff --git a/changelogs/client_server/newsfragments/3091.clarification b/changelogs/client_server/newsfragments/3091.clarification index 88868b3e..d0f1eb5e 100644 --- a/changelogs/client_server/newsfragments/3091.clarification +++ b/changelogs/client_server/newsfragments/3091.clarification @@ -1 +1 @@ -Fix example MXC URI for m.presence. \ No newline at end of file +Fix example MXC URI for `m.presence`. \ No newline at end of file diff --git a/changelogs/client_server/newsfragments/3098.feature b/changelogs/client_server/newsfragments/3098.feature index 0f3c3ab8..3eeacef0 100644 --- a/changelogs/client_server/newsfragments/3098.feature +++ b/changelogs/client_server/newsfragments/3098.feature @@ -1 +1 @@ -Add support for spoilers ([MSC2010](https://github.com/matrix-org/matrix-doc/pull/2010) and [MSC2557](https://github.com/matrix-org/matrix-doc/pull/2557)), and `color` attribute ([MSC2422](https://github.com/matrix-org/matrix-doc/pull/2422)). \ No newline at end of file +Add support for spoilers as per [MSC2010](https://github.com/matrix-org/matrix-doc/pull/2010) and [MSC2557](https://github.com/matrix-org/matrix-doc/pull/2557), and `color` attribute as per [MSC2422](https://github.com/matrix-org/matrix-doc/pull/2422). \ No newline at end of file diff --git a/changelogs/client_server/newsfragments/3149.feature b/changelogs/client_server/newsfragments/3149.feature index 2a85b47f..a1645d31 100644 --- a/changelogs/client_server/newsfragments/3149.feature +++ b/changelogs/client_server/newsfragments/3149.feature @@ -1 +1 @@ -Add key verification method using QR codes ([MSC1544](https://github.com/matrix-org/matrix-doc/pull/1544)). +Add key verification method using QR codes as per [MSC1544](https://github.com/matrix-org/matrix-doc/pull/1544). diff --git a/changelogs/client_server/newsfragments/3151.feature b/changelogs/client_server/newsfragments/3151.feature index a6aa98e9..2708a219 100644 --- a/changelogs/client_server/newsfragments/3151.feature +++ b/changelogs/client_server/newsfragments/3151.feature @@ -1 +1 @@ -Document how clients can simplify usage of Secure Secret Storage ([MSC2874](https://github.com/uhoreg/matrix-doc/pull/new/single_ssss_spec)). +Document how clients can simplify usage of Secure Secret Storage as per [MSC2874](https://github.com/matrix-org/matrix-doc/pull/2874). diff --git a/changelogs/client_server/newsfragments/3163.new b/changelogs/client_server/newsfragments/3163.new index ba41fd8d..bd699617 100644 --- a/changelogs/client_server/newsfragments/3163.new +++ b/changelogs/client_server/newsfragments/3163.new @@ -1 +1 @@ -`/login/sso/redirect/{idpId}` has been added as per [MSC2858](https://github.com/matrix-org/matrix-doc/pull/2858). \ No newline at end of file +Add `/login/sso/redirect/{idpId}` as per [MSC2858](https://github.com/matrix-org/matrix-doc/pull/2858). \ No newline at end of file diff --git a/changelogs/client_server/newsfragments/3199.deprecaation b/changelogs/client_server/newsfragments/3199.deprecation similarity index 100% rename from changelogs/client_server/newsfragments/3199.deprecaation rename to changelogs/client_server/newsfragments/3199.deprecation diff --git a/changelogs/client_server/newsfragments/3327.breaking b/changelogs/client_server/newsfragments/3327.breaking deleted file mode 100644 index 85c0da8b..00000000 --- a/changelogs/client_server/newsfragments/3327.breaking +++ /dev/null @@ -1 +0,0 @@ -Fix key_backup operation IDs in OpenAPI spec. diff --git a/changelogs/client_server/newsfragments/3330.clarification b/changelogs/client_server/newsfragments/3330.clarification index 5df676a1..e92fb5b5 100644 --- a/changelogs/client_server/newsfragments/3330.clarification +++ b/changelogs/client_server/newsfragments/3330.clarification @@ -1 +1 @@ -Add titles for OpenAPI objects. +Add missing titles to some scheams. diff --git a/changelogs/client_server/newsfragments/3331.clarification b/changelogs/client_server/newsfragments/3331.clarification index 4e0836b8..fd4ebf6c 100644 --- a/changelogs/client_server/newsfragments/3331.clarification +++ b/changelogs/client_server/newsfragments/3331.clarification @@ -1 +1 @@ -Add auth property to UIA endpoint uploadCrossSigningKeys. +Add User-Interactive Authentication fields to cross-signing APIs as per [MSC1756](https://github.com/matrix-org/matrix-doc/pull/1756). diff --git a/changelogs/client_server/newsfragments/3336.clarification b/changelogs/client_server/newsfragments/3336.clarification deleted file mode 100644 index bb06ffec..00000000 --- a/changelogs/client_server/newsfragments/3336.clarification +++ /dev/null @@ -1 +0,0 @@ -Disambiguate getEvents and peekEvents, and include both in swagger. diff --git a/changelogs/server_server/newsfragments/2536.feature b/changelogs/server_server/newsfragments/2536.feature index c2ea2d32..19bc8df9 100644 --- a/changelogs/server_server/newsfragments/2536.feature +++ b/changelogs/server_server/newsfragments/2536.feature @@ -1,9 +1 @@ -Add cross-signing: - -- Add properties to the response of `GET /user/keys` and `GET - /user/devices/{userId}`. -- The `m.device_list_update` EDU is sent when a device gets a new signature. -- A new `m.signing_key_update` EDU is sent when a user's cross-signing keys - are changed. - -per [MSC1756](https://github.com/matrix-org/matrix-doc/pull/1756). +Add cross-signing information to `GET /user/keys` and `GET /user/devices/{userId}`, `m.device_list_update` EDU, and a new `m.signing_key_update` EDU as per [MSC1756](https://github.com/matrix-org/matrix-doc/pull/1756).