Client-Server r0.5.0

pull/977/head
Travis Ralston 6 years ago
parent f44483a8cf
commit 1ca60bf5d7

@ -1,3 +1,85 @@
r0.5.0
======
Breaking Changes
----------------
- Add a new ``submit_url`` field to the responses of ``/requestToken`` which older clients will not be able to handle correctly. (`#2101 <https://github.com/matrix-org/matrix-doc/issues/2101>`_)
Deprecations
------------
- Remove references to presence lists. (`#1817 <https://github.com/matrix-org/matrix-doc/issues/1817>`_)
New Endpoints
-------------
- ``GET /account_data`` routes. (`#1873 <https://github.com/matrix-org/matrix-doc/issues/1873>`_)
Backwards Compatible Changes
----------------------------
- Add megolm session export format. (`#1701 <https://github.com/matrix-org/matrix-doc/issues/1701>`_)
- Add support for advertising experimental features to clients. (`#1786 <https://github.com/matrix-org/matrix-doc/issues/1786>`_)
- Add a generic SSO login API. (`#1789 <https://github.com/matrix-org/matrix-doc/issues/1789>`_)
- Add a mechanism for servers to redirect clients to an alternative homeserver after logging in. (`#1790 <https://github.com/matrix-org/matrix-doc/issues/1790>`_)
- Add room version upgrades. (`#1791 <https://github.com/matrix-org/matrix-doc/issues/1791>`_, `#1875 <https://github.com/matrix-org/matrix-doc/issues/1875>`_)
- Support optional features by having clients query for capabilities. (`#1829 <https://github.com/matrix-org/matrix-doc/issues/1829>`_, `#1879 <https://github.com/matrix-org/matrix-doc/issues/1879>`_)
- Add ``M_RESOURCE_LIMIT_EXCEEDED`` as an error code for when homeservers exceed limits imposed on them. (`#1874 <https://github.com/matrix-org/matrix-doc/issues/1874>`_)
- Emit ``M_UNSUPPORTED_ROOM_VERSION`` error codes where applicable on ``/createRoom`` and ``/invite`` APIs. (`#1908 <https://github.com/matrix-org/matrix-doc/issues/1908>`_)
- Add a ``.m.rule.tombstone`` default push rule for room ugprade notifications. (`#2020 <https://github.com/matrix-org/matrix-doc/issues/2020>`_)
- Add support for sending server notices to clients. (`#2026 <https://github.com/matrix-org/matrix-doc/issues/2026>`_)
- Add MSISDN (phone number) support to User-Interactive Authentication. (`#2030 <https://github.com/matrix-org/matrix-doc/issues/2030>`_)
- Add the option to lazy-load room members for increased client performance. (`#2035 <https://github.com/matrix-org/matrix-doc/issues/2035>`_)
- Add ``id_server`` to ``/deactivate`` and ``/3pid/delete`` endpoints to unbind from a specific identity server. (`#2046 <https://github.com/matrix-org/matrix-doc/issues/2046>`_)
- Add support for Olm sessions becoming un-stuck. (`#2059 <https://github.com/matrix-org/matrix-doc/issues/2059>`_)
- Add interactive device verification, including a common framework for device verification. (`#2072 <https://github.com/matrix-org/matrix-doc/issues/2072>`_)
Spec Clarifications
-------------------
- Change examples to use example.org instead of a real domain. (`#1650 <https://github.com/matrix-org/matrix-doc/issues/1650>`_)
- Clarify that ``state_default`` in ``m.room.power_levels`` always defaults to 50. (`#1656 <https://github.com/matrix-org/matrix-doc/issues/1656>`_)
- Add missing ``status_msg`` to ``m.presence`` schema. (`#1744 <https://github.com/matrix-org/matrix-doc/issues/1744>`_)
- Fix various spelling mistakes throughout the specification. (`#1838 <https://github.com/matrix-org/matrix-doc/issues/1838>`_, `#1853 <https://github.com/matrix-org/matrix-doc/issues/1853>`_, `#1860 <https://github.com/matrix-org/matrix-doc/issues/1860>`_, `#1933 <https://github.com/matrix-org/matrix-doc/issues/1933>`_, `#1969 <https://github.com/matrix-org/matrix-doc/issues/1969>`_, `#1988 <https://github.com/matrix-org/matrix-doc/issues/1988>`_, `#1989 <https://github.com/matrix-org/matrix-doc/issues/1989>`_, `#1991 <https://github.com/matrix-org/matrix-doc/issues/1991>`_, `#1992 <https://github.com/matrix-org/matrix-doc/issues/1992>`_)
- Add the missing ``m.push_rules`` event schema. (`#1889 <https://github.com/matrix-org/matrix-doc/issues/1889>`_)
- Clarify how modern day local echo is meant to be solved by clients. (`#1891 <https://github.com/matrix-org/matrix-doc/issues/1891>`_)
- Clarify that ``width`` and ``height`` are required parameters on ``/_matrix/media/r0/thumbnail/{serverName}/{mediaId}``. (`#1975 <https://github.com/matrix-org/matrix-doc/issues/1975>`_)
- Clarify how ``m.login.dummy`` can be used to disambiguate login flows. (`#1999 <https://github.com/matrix-org/matrix-doc/issues/1999>`_)
- Remove ``prev_content`` from the redaction algorithm's essential keys list. (`#2016 <https://github.com/matrix-org/matrix-doc/issues/2016>`_)
- Fix the ``third_party_signed`` definitions for the join APIs. (`#2025 <https://github.com/matrix-org/matrix-doc/issues/2025>`_)
- Clarify why User Interactive Auth is used on password changes and how access tokens are handled. (`#2027 <https://github.com/matrix-org/matrix-doc/issues/2027>`_)
- Clarify that devices are deleted upon logout. (`#2028 <https://github.com/matrix-org/matrix-doc/issues/2028>`_)
- Add ``M_NOT_FOUND`` error definition for deleting room aliases. (`#2029 <https://github.com/matrix-org/matrix-doc/issues/2029>`_)
- Add missing ``reason`` to ``m.call.hangup``. (`#2031 <https://github.com/matrix-org/matrix-doc/issues/2031>`_)
- Clarify how redactions affect room state. (`#2032 <https://github.com/matrix-org/matrix-doc/issues/2032>`_)
- Clarify that ``FAIL_ERROR`` in autodiscovery is not limited to just homeservers. (`#2036 <https://github.com/matrix-org/matrix-doc/issues/2036>`_)
- Fix example ``Content-Type`` for ``/media/upload`` request. (`#2041 <https://github.com/matrix-org/matrix-doc/issues/2041>`_)
- Clarify that login flows are meant to be completed in order. (`#2042 <https://github.com/matrix-org/matrix-doc/issues/2042>`_)
- Clarify that clients should not send read receipts for their own messages. (`#2043 <https://github.com/matrix-org/matrix-doc/issues/2043>`_)
- Use consistent examples of events throughout the specification. (`#2051 <https://github.com/matrix-org/matrix-doc/issues/2051>`_)
- Clarify which push rule condition kinds exist. (`#2052 <https://github.com/matrix-org/matrix-doc/issues/2052>`_)
- Clarify the required fields on ``m.file`` (and similar) messages. (`#2053 <https://github.com/matrix-org/matrix-doc/issues/2053>`_)
- Clarify that User-Interactive Authentication stages cannot be attempted more than once. (`#2054 <https://github.com/matrix-org/matrix-doc/issues/2054>`_)
- Clarify which parameters apply in what scenarios on ``/register``. (`#2055 <https://github.com/matrix-org/matrix-doc/issues/2055>`_)
- Clarify how to interpret changes of ``membership`` over time. (`#2056 <https://github.com/matrix-org/matrix-doc/issues/2056>`_)
- Clarify exactly what invite_room_state consists of. (`#2067 <https://github.com/matrix-org/matrix-doc/issues/2067>`_)
- Clarify how the content repository works, and what it is used for. (`#2068 <https://github.com/matrix-org/matrix-doc/issues/2068>`_)
- Clarify the order events in chunk are returned in for ``/messages``. (`#2069 <https://github.com/matrix-org/matrix-doc/issues/2069>`_)
- Clarify the key object definition for the key management API. (`#2083 <https://github.com/matrix-org/matrix-doc/issues/2083>`_)
- Reorganize information about events into a common section. (`#2087 <https://github.com/matrix-org/matrix-doc/issues/2087>`_)
- De-duplicate ``/state/<event_type>`` endpoints, clarifying that the ``<state_key>`` is optional. (`#2088 <https://github.com/matrix-org/matrix-doc/issues/2088>`_)
- Clarify when and where CORS headers should be returned. (`#2089 <https://github.com/matrix-org/matrix-doc/issues/2089>`_)
- Clarify when authorization and rate-limiting are not applicable. (`#2090 <https://github.com/matrix-org/matrix-doc/issues/2090>`_)
- Clarify that ``/register`` must produce valid Matrix User IDs. (`#2091 <https://github.com/matrix-org/matrix-doc/issues/2091>`_)
- Clarify how ``unread_notifications`` is calculated. (`#2097 <https://github.com/matrix-org/matrix-doc/issues/2097>`_)
- Clarify what a "module" is and update feature profiles for clients. (`#2098 <https://github.com/matrix-org/matrix-doc/issues/2098>`_)
r0.4.0
======

@ -1 +0,0 @@
Change examples to use example.org instead of a real domain.

@ -1 +0,0 @@
Clarify that ``state_default`` in ``m.room.power_levels`` always defaults to 50.

@ -1 +0,0 @@
Add megolm session export format.

@ -1 +0,0 @@
Add missing ``status_msg`` to ``m.presence`` schema.

@ -1 +0,0 @@
Add support for advertising experimental features to clients.

@ -1 +0,0 @@
Add a mechanism for servers to redirect clients to an alternative homeserver after logging in.

@ -1 +0,0 @@
Remove references to presence lists.

@ -1 +0,0 @@
Support optional features by having clients query for capabilities.

@ -1 +0,0 @@
Fix various spelling mistakes throughout the specification.

@ -1 +0,0 @@
Fix various spelling mistakes throughout the specification.

@ -1 +0,0 @@
Fix various spelling mistakes throughout the specification.

@ -1 +0,0 @@
``GET /account_data`` routes.

@ -1 +0,0 @@
Add ``M_RESOURCE_LIMIT_EXCEEDED`` as an error code for when homeservers exceed limits imposed on them.

@ -1 +0,0 @@
Support optional features by having clients query for capabilities.

@ -1 +0,0 @@
Add the missing ``m.push_rules`` event schema.

@ -1 +0,0 @@
Clarify how modern day local echo is meant to be solved by clients.

@ -1 +0,0 @@
Emit ``M_UNSUPPORTED_ROOM_VERSION`` error codes where applicable on ``/createRoom`` and ``/invite`` APIs.

@ -1 +0,0 @@
Fix various spelling mistakes throughout the specification.

@ -1 +0,0 @@
Fix various spelling mistakes throughout the specification.

@ -1 +0,0 @@
Clarify that ``width`` and ``height`` are required parameters on ``/_matrix/media/r0/thumbnail/{serverName}/{mediaId}``.

@ -1 +0,0 @@
Fix various spelling mistakes throughout the specification.

@ -1 +0,0 @@
Fix various spelling mistakes throughout the specification.

@ -1 +0,0 @@
Fix various spelling mistakes throughout the specification.

@ -1 +0,0 @@
Fix various spelling mistakes throughout the specification.

@ -1 +0,0 @@
Clarify how ``m.login.dummy`` can be used to disambiguate login flows.

@ -1 +0,0 @@
Remove ``prev_content`` from the redaction algorithm's essential keys list.

@ -1 +0,0 @@
Add a ``.m.rule.tombstone`` default push rule for room ugprade notifications.

@ -1 +0,0 @@
Fix the ``third_party_signed`` definitions for the join APIs.

@ -1 +0,0 @@
Add support for sending server notices to clients.

@ -1 +0,0 @@
Clarify why User Interactive Auth is used on password changes and how access tokens are handled.

@ -1 +0,0 @@
Clarify that devices are deleted upon logout.

@ -1 +0,0 @@
Add ``M_NOT_FOUND`` error definition for deleting room aliases.

@ -1 +0,0 @@
Add MSISDN (phone number) support to User-Interactive Authentication.

@ -1 +0,0 @@
Add missing ``reason`` to ``m.call.hangup``.

@ -1 +0,0 @@
Clarify how redactions affect room state.

@ -1 +0,0 @@
Add the option to lazy-load room members for increased client performance.

@ -1 +0,0 @@
Clarify that ``FAIL_ERROR`` in autodiscovery is not limited to just homeservers.

@ -1 +0,0 @@
Fix example ``Content-Type`` for ``/media/upload`` request.

@ -1 +0,0 @@
Clarify that login flows are meant to be completed in order.

@ -1 +0,0 @@
Clarify that clients should not send read receipts for their own messages.

@ -1 +0,0 @@
Add ``id_server`` to ``/deactivate`` and ``/3pid/delete`` endpoints to unbind from a specific identity server.

@ -1 +0,0 @@
Use consistent examples of events throughout the specification.

@ -1 +0,0 @@
Clarify which push rule condition kinds exist.

@ -1 +0,0 @@
Clarify the required fields on ``m.file`` (and similar) messages.

@ -1 +0,0 @@
Clarify that User-Interactive Authentication stages cannot be attempted more than once.

@ -1 +0,0 @@
Clarify which parameters apply in what scenarios on ``/register``.

@ -1 +0,0 @@
Clarify how to interpret changes of ``membership`` over time.

@ -1 +0,0 @@
Add support for Olm sessions becoming un-stuck.

@ -1 +0,0 @@
Clarify exactly what invite_room_state consists of.

@ -1 +0,0 @@
Clarify how the content repository works, and what it is used for.

@ -1 +0,0 @@
Clarify the order events in chunk are returned in for ``/messages``.

@ -1 +0,0 @@
Add interactive device verification, including a common framework for device verification.

@ -1 +0,0 @@
Clarify the key object definition for the key management API.

@ -1 +0,0 @@
Reorganize information about events into a common section.

@ -1 +0,0 @@
De-duplicate ``/state/<event_type>`` endpoints, clarifying that the ``<state_key>`` is optional.

@ -1 +0,0 @@
Clarify when and where CORS headers should be returned.

@ -1 +0,0 @@
Clarify when authorization and rate-limiting are not applicable.

@ -1 +0,0 @@
Clarify that ``/register`` must produce valid Matrix User IDs.

@ -1 +0,0 @@
Clarify how ``unread_notifications`` is calculated.

@ -1 +0,0 @@
Clarify what a "module" is and update feature profiles for clients.

@ -1 +0,0 @@
Add a new ``submit_url`` field to the responses of ``/requestToken`` which older clients will not be able to handle correctly.

@ -45,6 +45,7 @@ Other versions of this specification
The following other versions are also available, in reverse chronological order:
- `HEAD <https://matrix.org/docs/spec/client_server/unstable.html>`_: Includes all changes since the latest versioned release.
- `r0.5.0 <https://matrix.org/docs/spec/client_server/r0.5.0.html>`_
- `r0.4.0 <https://matrix.org/docs/spec/client_server/r0.4.0.html>`_
- `r0.3.0 <https://matrix.org/docs/spec/client_server/r0.3.0.html>`_
- `r0.2.0 <https://matrix.org/docs/spec/client_server/r0.2.0.html>`_

Loading…
Cancel
Save