Merge branch 'master' into client_server/release-r0.5.0

2025-12-28 11:48:36 +01:00 · 2019-06-11 11:31:39 -06:00 · 2019-06-11 11:31:39 -06:00 · db8d118ceb
parent 1ca60bf5d7 19a3d574b7
commit db8d118ceb
34 changed files with 68 additions and 33 deletions
--- a/api/client-server/event_context.yaml
+++ b/api/client-server/event_context.yaml
@ -35,8 +35,8 @@ paths:
        after the specified event. This allows clients to get the context
        surrounding an event.

-        *Note*: This endpoint supports lazy-loading of room member events. See `Filtering <#lazy-loading-room-members>`_
-        for more information.
+        *Note*: This endpoint supports lazy-loading of room member events. See
+        `Lazy-loading room members <#lazy-loading-room-members>`_ for more information.
      operationId: getEventContext
      security:
        - accessToken: []
--- a/api/client-server/message_pagination.yaml
+++ b/api/client-server/message_pagination.yaml
@ -34,8 +34,8 @@ paths:
        This API returns a list of message and state events for a room. It uses
        pagination query parameters to paginate history in the room.

-        *Note*: This endpoint supports lazy-loading of room member events. See `Filtering <#lazy-loading-room-members>`_
-        for more information.
+        *Note*: This endpoint supports lazy-loading of room member events. See
+        `Lazy-loading room members <#lazy-loading-room-members>`_ for more information.
      operationId: getRoomEvents
      security:
        - accessToken: []
--- a/changelogs/application_service.rst
+++ b/changelogs/application_service.rst
@ -1,3 +1,13 @@
+r0.1.1
+======
+
+Spec Clarifications
+-------------------
+
+- Change examples to use example.org instead of a real domain. (`#1650 <https://github.com/matrix-org/matrix-doc/issues/1650>`_)
+- Add missing definition for how appservices verify requests came from a homeserver. (`#2037 <https://github.com/matrix-org/matrix-doc/issues/2037>`_)
+
+
 r0.1.0
 ======

--- a/changelogs/application_service/newsfragments/1650.clarification
+++ b/changelogs/application_service/newsfragments/1650.clarification
@ -1 +0,0 @@
-Change examples to use example.org instead of a real domain.
--- a/changelogs/application_service/newsfragments/2037.clarification
+++ b/changelogs/application_service/newsfragments/2037.clarification
@ -1 +0,0 @@
-Add missing definition for how appservices verify requests came from a homeserver.
--- a/changelogs/identity_service.rst
+++ b/changelogs/identity_service.rst
@ -1,3 +1,22 @@
+r0.2.0
+======
+
+New Endpoints
+-------------
+
+- Add ``/3pid/unbind`` for removing 3PIDs. (`#2046 <https://github.com/matrix-org/matrix-doc/issues/2046>`_)
+
+
+Spec Clarifications
+-------------------
+
+- Fix various spelling mistakes throughout the specification. (`#1853 <https://github.com/matrix-org/matrix-doc/issues/1853>`_)
+- Fix route for ``/3pid/bind``. (`#1967 <https://github.com/matrix-org/matrix-doc/issues/1967>`_)
+- Add missing aesthetic parameters to ``/store-invite``. (`#2049 <https://github.com/matrix-org/matrix-doc/issues/2049>`_)
+- Clarify what the client should receive upon sending an identical email validation request multiple times. (`#2057 <https://github.com/matrix-org/matrix-doc/issues/2057>`_)
+- Clarify that the default transport is JSON over HTTP. (`#2086 <https://github.com/matrix-org/matrix-doc/issues/2086>`_)
+
+
 r0.1.0
 ======

--- a/changelogs/identity_service/newsfragments/1853.clarification
+++ b/changelogs/identity_service/newsfragments/1853.clarification
@ -1 +0,0 @@
-Fix various spelling mistakes throughout the specification.
--- a/changelogs/identity_service/newsfragments/1967.clarification
+++ b/changelogs/identity_service/newsfragments/1967.clarification
@ -1 +0,0 @@
-Fix route for ``/3pid/bind``.
--- a/changelogs/identity_service/newsfragments/2046.new
+++ b/changelogs/identity_service/newsfragments/2046.new
@ -1 +0,0 @@
-Add ``/3pid/unbind`` for removing 3PIDs.
--- a/changelogs/identity_service/newsfragments/2049.clarification
+++ b/changelogs/identity_service/newsfragments/2049.clarification
@ -1 +0,0 @@
-Add missing aesthetic parameters to ``/store-invite``.
--- a/changelogs/identity_service/newsfragments/2057.clarification
+++ b/changelogs/identity_service/newsfragments/2057.clarification
@ -1 +0,0 @@
-Clarify what the client should receive upon sending an identical email validation request multiple times.
--- a/changelogs/identity_service/newsfragments/2086.clarification
+++ b/changelogs/identity_service/newsfragments/2086.clarification
@ -1 +0,0 @@
-Clarify that the default transport is JSON over HTTP.
--- a/changelogs/server_server.rst
+++ b/changelogs/server_server.rst
@ -1,3 +1,20 @@
+r0.1.2
+======
+
+Spec Clarifications
+-------------------
+
+- Change examples to use example.org instead of a real domain. (`#1650 <https://github.com/matrix-org/matrix-doc/issues/1650>`_)
+- Fix the ``access_token`` parameter in the open_id endpoint. (`#1906 <https://github.com/matrix-org/matrix-doc/issues/1906>`_)
+- Fix various spelling mistakes throughout the specification. (`#1991 <https://github.com/matrix-org/matrix-doc/issues/1991>`_)
+- Clarify exactly what invite_room_state consists of. (`#2067 <https://github.com/matrix-org/matrix-doc/issues/2067>`_)
+- Clarify how ``valid_until_ts`` behaves with respect to room version. (`#2080 <https://github.com/matrix-org/matrix-doc/issues/2080>`_)
+- Clarify which servers are supposed to sign events. (`#2081 <https://github.com/matrix-org/matrix-doc/issues/2081>`_)
+- Clarify the key object definition for the key management API. (`#2083 <https://github.com/matrix-org/matrix-doc/issues/2083>`_)
+- Clarify how many PDUs are contained in transaction objects for various endpoints. (`#2095 <https://github.com/matrix-org/matrix-doc/issues/2095>`_)
+- Clarify that the trailing slash is optional on ``/keys/*`` endpoints when no key ID is requested. (`#2097 <https://github.com/matrix-org/matrix-doc/issues/2097>`_)
+
+
 r0.1.1
 ======

--- a/changelogs/server_server/newsfragments/1650.clarification
+++ b/changelogs/server_server/newsfragments/1650.clarification
@ -1 +0,0 @@
-Change examples to use example.org instead of a real domain.
--- a/changelogs/server_server/newsfragments/1906.clarification
+++ b/changelogs/server_server/newsfragments/1906.clarification
@ -1 +0,0 @@
-Fix the ``access_token`` parameter in the open_id endpoint.
--- a/changelogs/server_server/newsfragments/1991.clarification
+++ b/changelogs/server_server/newsfragments/1991.clarification
@ -1 +0,0 @@
-Fix various spelling mistakes throughout the specification.
--- a/changelogs/server_server/newsfragments/2067.clarification
+++ b/changelogs/server_server/newsfragments/2067.clarification
@ -1 +0,0 @@
-Clarify exactly what invite_room_state consists of.
--- a/changelogs/server_server/newsfragments/2080.clarification
+++ b/changelogs/server_server/newsfragments/2080.clarification
@ -1 +0,0 @@
-Clarify how ``valid_until_ts`` behaves with respect to room version.
--- a/changelogs/server_server/newsfragments/2081.clarification
+++ b/changelogs/server_server/newsfragments/2081.clarification
@ -1 +0,0 @@
-Clarify which servers are supposed to sign events.
--- a/changelogs/server_server/newsfragments/2083.clarification
+++ b/changelogs/server_server/newsfragments/2083.clarification
@ -1 +0,0 @@
-Clarify the key object definition for the key management API.
--- a/changelogs/server_server/newsfragments/2095.clarification
+++ b/changelogs/server_server/newsfragments/2095.clarification
@ -1 +0,0 @@
-Clarify how many PDUs are contained in transaction objects for various endpoints.
--- a/changelogs/server_server/newsfragments/2097.clarification
+++ b/changelogs/server_server/newsfragments/2097.clarification
@ -1 +0,0 @@
-Clarify that the trailing slash is optional on ``/keys/*`` endpoints when no key ID is requested.
--- a/specification/application_service_api.rst
+++ b/specification/application_service_api.rst
@ -52,6 +52,7 @@ Other versions of this specification
 The following other versions are also available, in reverse chronological order:

 - `HEAD <https://matrix.org/docs/spec/application_service/unstable.html>`_: Includes all changes since the latest versioned release.
+- `r0.1.1 <https://matrix.org/docs/spec/application_service/r0.1.1.html>`_
 - `r0.1.0 <https://matrix.org/docs/spec/application_service/r0.1.0.html>`_


--- a/specification/client_server_api.rst
+++ b/specification/client_server_api.rst
@ -1491,6 +1491,8 @@ Some event types have additional size restrictions which are specified in
 the description of the event. Additional keys have no limit other than that
 implied by the total 65 KB limit on events.

+.. _`Canonical JSON`: ../appendices.html#canonical-json
+
 Room Events
 ~~~~~~~~~~~
 .. NOTE::
--- a/specification/identity_service_api.rst
+++ b/specification/identity_service_api.rst
@ -51,6 +51,7 @@ Other versions of this specification
 The following other versions are also available, in reverse chronological order:

 - `HEAD <https://matrix.org/docs/spec/identity_service/unstable.html>`_: Includes all changes since the latest versioned release.
+- `r0.2.0 <https://matrix.org/docs/spec/identity_service/r0.2.0.html>`_
 - `r0.1.0 <https://matrix.org/docs/spec/identity_service/r0.1.0.html>`_

 General principles
@ -279,4 +280,4 @@ this isn't possible.
 .. _`Unpadded Base64`:  ../appendices.html#unpadded-base64
 .. _`3PID Types`:  ../appendices.html#pid-types
 .. _`Signing JSON`: ../appendices.html#signing-json
-.. _`/3pid/onbind`: ../server_server/r0.1.1.html#put-matrix-federation-v1-3pid-onbind
+.. _`/3pid/onbind`: ../server_server/%SERVER_RELEASE_LABEL%.html#put-matrix-federation-v1-3pid-onbind
--- a/specification/modules/end_to_end_encryption.rst
+++ b/specification/modules/end_to_end_encryption.rst
@ -671,6 +671,7 @@ parameter is the concatenation of:
  * The ``transaction_id`` being used.

 .. admonition:: Rationale
+
  HKDF is used over the plain shared secret as it results in a harder attack
  as well as more uniform data to work with.

--- a/specification/modules/send_to_device.rst
+++ b/specification/modules/send_to_device.rst
@ -63,7 +63,7 @@ If the client sends messages to users on remote domains, those messages should
 be sent on to the remote servers via
 `federation`_.

-.. _`federation`: ../server_server/latest.html#send-to-device-messaging
+.. _`federation`: ../server_server/%SERVER_RELEASE_LABEL%.html#send-to-device-messaging

 .. TODO-spec:

--- a/specification/modules/third_party_invites.rst
+++ b/specification/modules/third_party_invites.rst
@ -255,4 +255,4 @@ these is left to the implementer's discretion.



-.. _`identity server /isvalid`: ../identity_service/unstable.html#get-matrix-identity-api-v1-pubkey-isvalid
+.. _`identity server /isvalid`: ../identity_service/%IDENTITY_RELEASE_LABEL%.html#get-matrix-identity-api-v1-pubkey-isvalid
--- a/specification/rooms/v1.rst
+++ b/specification/rooms/v1.rst
@ -293,5 +293,5 @@ Events in version 1 rooms have the following structure:
 {{definition_ss_pdu}}


-.. _`auth events selection`: ../server_server/r0.1.1.html#auth-events-selection
-.. _`Signing Events`: ../server_server/r0.1.1.html#signing-events
+.. _`auth events selection`: ../server_server/%SERVER_RELEASE_LABEL%.html#auth-events-selection
+.. _`Signing Events`: ../server_server/%SERVER_RELEASE_LABEL%.html#signing-events
--- a/specification/rooms/v2.rst
+++ b/specification/rooms/v2.rst
@ -161,7 +161,7 @@ The *resolution* of a set of states is obtained as follows:
   resolved state.


-.. _`authorization rules`: ../server_server/r0.1.1.html#authorization-rules
+.. _`authorization rules`: ../server_server/%SERVER_RELEASE_LABEL%.html#authorization-rules

 Rejected events
 +++++++++++++++
--- a/specification/rooms/v3.rst
+++ b/specification/rooms/v3.rst
@ -120,5 +120,5 @@ The remaining rules are the same as `room version 1 <v1.html#authorization-rules

 .. _`Unpadded Base64`:  ../appendices.html#unpadded-base64
 .. _`Canonical JSON`: ../appendices.html#canonical-json
-.. _`Signing Events`: ../server_server/r0.1.1.html#signing-events
-.. _`reference hash`: ../server_server/r0.1.1.html#reference-hashes
+.. _`Signing Events`: ../server_server/%SERVER_RELEASE_LABEL%.html#signing-events
+.. _`reference hash`: ../server_server/%SERVER_RELEASE_LABEL%.html#reference-hashes
--- a/specification/rooms/v4.rst
+++ b/specification/rooms/v4.rst
@ -72,5 +72,5 @@ of ``auth_events`` and ``prev_events`` in a PDU.

 .. _`Unpadded Base64`:  ../appendices.html#unpadded-base64
 .. _`Canonical JSON`: ../appendices.html#canonical-json
-.. _`Signing Events`: ../server_server/r0.1.1.html#signing-events
-.. _`reference hash`: ../server_server/r0.1.1.html#reference-hashes
+.. _`Signing Events`: ../server_server/%SERVER_RELEASE_LABEL%.html#signing-events
+.. _`reference hash`: ../server_server/%SERVER_RELEASE_LABEL%.html#reference-hashes
--- a/specification/rooms/v5.rst
+++ b/specification/rooms/v5.rst
@ -48,8 +48,8 @@ Signing key validity period
 When validating event signatures, servers MUST enforce the ``valid_until_ts`` property
 from a key request is at least as large as the ``origin_server_ts`` for the event being
 validated. Servers missing a copy of the signing key MUST try to obtain one via the
-`GET /_matrix/key/v2/server <../server_server/r0.1.1.html#get-matrix-key-v2-server-keyid>`_
-or `POST /_matrix/key/v2/query <../server_server/r0.1.1.html#post-matrix-key-v2-query>`_
+`GET /_matrix/key/v2/server <../server_server/%SERVER_RELEASE_LABEL%.html#get-matrix-key-v2-server-keyid>`_
+or `POST /_matrix/key/v2/query <../server_server/%SERVER_RELEASE_LABEL%.html#post-matrix-key-v2-query>`_
 APIs. When using the ``/query`` endpoint, servers MUST set the ``minimum_valid_until_ts``
 property to prompt the notary server to attempt to refresh the key if appropriate.

--- a/specification/server_server_api.rst
+++ b/specification/server_server_api.rst
@ -80,6 +80,7 @@ Other versions of this specification
 The following other versions are also available, in reverse chronological order:

 - `HEAD <https://matrix.org/docs/spec/server_server/unstable.html>`_: Includes all changes since the latest versioned release.
+- `r0.1.2 <https://matrix.org/docs/spec/server_server/r0.1.2.html>`_
 - `r0.1.1 <https://matrix.org/docs/spec/server_server/r0.1.1.html>`_
 - `r0.1.0 <https://matrix.org/docs/spec/server_server/r0.1.0.html>`_
				`@ -1 +0,0 @@`
				`Change examples to use example.org instead of a real domain.`
				`@ -1 +0,0 @@`
				`Add missing definition for how appservices verify requests came from a homeserver.`
				`@ -1 +0,0 @@`
				`Fix various spelling mistakes throughout the specification.`
				`@ -1 +0,0 @@`
				Add missing aesthetic parameters to ``/store-invite``.
				`@ -1 +0,0 @@`
				`Clarify what the client should receive upon sending an identical email validation request multiple times.`
				`@ -1 +0,0 @@`
				`Clarify that the default transport is JSON over HTTP.`
				`@ -1 +0,0 @@`
				Fix the ``access_token`` parameter in the open_id endpoint.
				`@ -1 +0,0 @@`
				`Clarify exactly what invite_room_state consists of.`
				`@ -1 +0,0 @@`
				Clarify how ``valid_until_ts`` behaves with respect to room version.
				`@ -1 +0,0 @@`
				`Clarify which servers are supposed to sign events.`