From ff4514266358a7ac5f310d8718cae114f137ecd8 Mon Sep 17 00:00:00 2001 From: Daniel Wagner-Hall Date: Mon, 7 Dec 2015 15:19:54 +0000 Subject: [PATCH] Flesh out changelog I forgot to push this before merging PR 215 --- CHANGELOG.rst | 41 ------------------------------------ changelogs/client_server.rst | 27 ++++++++++++++++++++++++ 2 files changed, 27 insertions(+), 41 deletions(-) delete mode 100644 CHANGELOG.rst diff --git a/CHANGELOG.rst b/CHANGELOG.rst deleted file mode 100644 index fb50498fb..000000000 --- a/CHANGELOG.rst +++ /dev/null @@ -1,41 +0,0 @@ -.. This file is automatically processed by the templating system. To make it -.. happy, you MUST use '=' as the title underline and you MUST stick the version -.. in the title. The version MUST follow the numbering format -.. "v.." - You cannot use a-z. If the templating system fails to -.. find the right info, it will be treated as a test failure and so will show up -.. in Jenkins. Comments like this are ignored by both RST and the templating -.. system. Add the newest release notes beneath this comment. - -Specification changes in v0.2.0 (2015-10-02) -============================================ - -This update fundamentally restructures the specification. The specification has -been split into more digestible "modules" which each describe a particular -function (e.g. typing). This was done in order make the specification easier to -maintain and help define which modules are mandatory for certain types -of clients. Types of clients along with the mandatory modules can be found in a -new "Feature Profiles" section. This update also begins to aggressively -standardise on using Swagger and JSON Schema to document HTTP endpoints and -Events respectively. It also introduces a number of new concepts to Matrix. - -Additions: - - New section: Feature Profiles. - - New section: Receipts. - - New section: Room history visibility. - - New event: ``m.receipt``. - - New event: ``m.room.canonical_alias`` - - New event: ``m.room.history_visibility`` - - New keys: ``/createRoom`` - allows room "presets" using ``preset`` and - ``initial_state`` keys. - - New endpoint: ``/tokenrefresh`` - Related to refreshing access tokens. - -Modifications: - - Convert most of the older HTTP APIs to Swagger documentation. - - Convert most of the older event formats to JSON Schema. - - Move selected client-server sections to be "Modules". - -Specification changes in v0.1.0 (2015-06-01) -============================================ -- First numbered release. -- Restructure the format of Event information. Add more information. -- Restructure the format of the Client-Server HTTP APIs. diff --git a/changelogs/client_server.rst b/changelogs/client_server.rst index ef467a3c4..f1c8f10ce 100644 --- a/changelogs/client_server.rst +++ b/changelogs/client_server.rst @@ -7,4 +7,31 @@ An upcoming minor release will deprecate many of these inconsistencies, and they Since the draft stage, the following major changes have been made: - /api/v1 and /v2_alpha path segments have been replaced with the major version of the release (i.e. 'r0'). +- Some POST versions of APIs with both POST and PUT have been removed. - The specification has been split into one specification per API. This is the client-server API. The server-server API can be found documented separately. +- All APIs are now documented using Swagger +- The following modules have been added: + - Content repository + - Instant messaging + - Push notification + - History visibility + - Search + - Invites based on third party identifiers + - Room tagging + - Guest access + - Client config +- The following APIs were added: + - ``/sync`` + - ``/publicRooms`` + - ``/rooms/{roomId}/forget`` + - ``/admin/whois`` + - ``/rooms/{roomId}/redact`` + - ``/user/{userId}/filter`` +- The following APIs have been significantly modified: + - Invitations now contain partial room state + - Invitations can now be rejected + - ``/directory`` +- The following events have been added: + - ``m.room.avatar`` +- Example signed json is included for reference +- Commentary on display name calculation was added