diff --git a/api/client-server/event_context.yaml b/api/client-server/event_context.yaml index 802f5f27..3bea351c 100644 --- 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: [] diff --git a/api/client-server/message_pagination.yaml b/api/client-server/message_pagination.yaml index dc33b717..22828219 100644 --- 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: [] diff --git a/changelogs/application_service.rst b/changelogs/application_service.rst index 9d098837..bbc461b2 100644 --- 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 `_) +- Add missing definition for how appservices verify requests came from a homeserver. (`#2037 `_) + + r0.1.0 ====== diff --git a/changelogs/application_service/newsfragments/1650.clarification b/changelogs/application_service/newsfragments/1650.clarification deleted file mode 100644 index 617b7ab6..00000000 --- a/changelogs/application_service/newsfragments/1650.clarification +++ /dev/null @@ -1 +0,0 @@ -Change examples to use example.org instead of a real domain. diff --git a/changelogs/application_service/newsfragments/2037.clarification b/changelogs/application_service/newsfragments/2037.clarification deleted file mode 100644 index f425b1c1..00000000 --- a/changelogs/application_service/newsfragments/2037.clarification +++ /dev/null @@ -1 +0,0 @@ -Add missing definition for how appservices verify requests came from a homeserver. diff --git a/changelogs/identity_service.rst b/changelogs/identity_service.rst index 0405d515..d60812b8 100644 --- 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 `_) + + +Spec Clarifications +------------------- + +- Fix various spelling mistakes throughout the specification. (`#1853 `_) +- Fix route for ``/3pid/bind``. (`#1967 `_) +- Add missing aesthetic parameters to ``/store-invite``. (`#2049 `_) +- Clarify what the client should receive upon sending an identical email validation request multiple times. (`#2057 `_) +- Clarify that the default transport is JSON over HTTP. (`#2086 `_) + + r0.1.0 ====== diff --git a/changelogs/identity_service/newsfragments/1853.clarification b/changelogs/identity_service/newsfragments/1853.clarification deleted file mode 100644 index b0f05203..00000000 --- a/changelogs/identity_service/newsfragments/1853.clarification +++ /dev/null @@ -1 +0,0 @@ -Fix various spelling mistakes throughout the specification. diff --git a/changelogs/identity_service/newsfragments/1967.clarification b/changelogs/identity_service/newsfragments/1967.clarification deleted file mode 100644 index b080caeb..00000000 --- a/changelogs/identity_service/newsfragments/1967.clarification +++ /dev/null @@ -1 +0,0 @@ -Fix route for ``/3pid/bind``. diff --git a/changelogs/identity_service/newsfragments/2046.new b/changelogs/identity_service/newsfragments/2046.new deleted file mode 100644 index 7146799b..00000000 --- a/changelogs/identity_service/newsfragments/2046.new +++ /dev/null @@ -1 +0,0 @@ -Add ``/3pid/unbind`` for removing 3PIDs. diff --git a/changelogs/identity_service/newsfragments/2049.clarification b/changelogs/identity_service/newsfragments/2049.clarification deleted file mode 100644 index 403ac8d0..00000000 --- a/changelogs/identity_service/newsfragments/2049.clarification +++ /dev/null @@ -1 +0,0 @@ -Add missing aesthetic parameters to ``/store-invite``. diff --git a/changelogs/identity_service/newsfragments/2057.clarification b/changelogs/identity_service/newsfragments/2057.clarification deleted file mode 100644 index de72c201..00000000 --- a/changelogs/identity_service/newsfragments/2057.clarification +++ /dev/null @@ -1 +0,0 @@ -Clarify what the client should receive upon sending an identical email validation request multiple times. diff --git a/changelogs/identity_service/newsfragments/2086.clarification b/changelogs/identity_service/newsfragments/2086.clarification deleted file mode 100644 index 7016308b..00000000 --- a/changelogs/identity_service/newsfragments/2086.clarification +++ /dev/null @@ -1 +0,0 @@ -Clarify that the default transport is JSON over HTTP. diff --git a/changelogs/server_server.rst b/changelogs/server_server.rst index a21da177..11f99a5f 100644 --- 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 `_) +- Fix the ``access_token`` parameter in the open_id endpoint. (`#1906 `_) +- Fix various spelling mistakes throughout the specification. (`#1991 `_) +- Clarify exactly what invite_room_state consists of. (`#2067 `_) +- Clarify how ``valid_until_ts`` behaves with respect to room version. (`#2080 `_) +- Clarify which servers are supposed to sign events. (`#2081 `_) +- Clarify the key object definition for the key management API. (`#2083 `_) +- Clarify how many PDUs are contained in transaction objects for various endpoints. (`#2095 `_) +- Clarify that the trailing slash is optional on ``/keys/*`` endpoints when no key ID is requested. (`#2097 `_) + + r0.1.1 ====== diff --git a/changelogs/server_server/newsfragments/1650.clarification b/changelogs/server_server/newsfragments/1650.clarification deleted file mode 100644 index 617b7ab6..00000000 --- a/changelogs/server_server/newsfragments/1650.clarification +++ /dev/null @@ -1 +0,0 @@ -Change examples to use example.org instead of a real domain. diff --git a/changelogs/server_server/newsfragments/1906.clarification b/changelogs/server_server/newsfragments/1906.clarification deleted file mode 100644 index 531fdb94..00000000 --- a/changelogs/server_server/newsfragments/1906.clarification +++ /dev/null @@ -1 +0,0 @@ -Fix the ``access_token`` parameter in the open_id endpoint. diff --git a/changelogs/server_server/newsfragments/1991.clarification b/changelogs/server_server/newsfragments/1991.clarification deleted file mode 100644 index b0f05203..00000000 --- a/changelogs/server_server/newsfragments/1991.clarification +++ /dev/null @@ -1 +0,0 @@ -Fix various spelling mistakes throughout the specification. diff --git a/changelogs/server_server/newsfragments/2067.clarification b/changelogs/server_server/newsfragments/2067.clarification deleted file mode 100644 index cc706274..00000000 --- a/changelogs/server_server/newsfragments/2067.clarification +++ /dev/null @@ -1 +0,0 @@ -Clarify exactly what invite_room_state consists of. diff --git a/changelogs/server_server/newsfragments/2080.clarification b/changelogs/server_server/newsfragments/2080.clarification deleted file mode 100644 index c568fa13..00000000 --- a/changelogs/server_server/newsfragments/2080.clarification +++ /dev/null @@ -1 +0,0 @@ -Clarify how ``valid_until_ts`` behaves with respect to room version. diff --git a/changelogs/server_server/newsfragments/2081.clarification b/changelogs/server_server/newsfragments/2081.clarification deleted file mode 100644 index fd291273..00000000 --- a/changelogs/server_server/newsfragments/2081.clarification +++ /dev/null @@ -1 +0,0 @@ -Clarify which servers are supposed to sign events. diff --git a/changelogs/server_server/newsfragments/2083.clarification b/changelogs/server_server/newsfragments/2083.clarification deleted file mode 100644 index 8083d85d..00000000 --- a/changelogs/server_server/newsfragments/2083.clarification +++ /dev/null @@ -1 +0,0 @@ -Clarify the key object definition for the key management API. diff --git a/changelogs/server_server/newsfragments/2095.clarification b/changelogs/server_server/newsfragments/2095.clarification deleted file mode 100644 index 66257e17..00000000 --- a/changelogs/server_server/newsfragments/2095.clarification +++ /dev/null @@ -1 +0,0 @@ -Clarify how many PDUs are contained in transaction objects for various endpoints. diff --git a/changelogs/server_server/newsfragments/2097.clarification b/changelogs/server_server/newsfragments/2097.clarification deleted file mode 100644 index 10dcecb6..00000000 --- a/changelogs/server_server/newsfragments/2097.clarification +++ /dev/null @@ -1 +0,0 @@ -Clarify that the trailing slash is optional on ``/keys/*`` endpoints when no key ID is requested. diff --git a/specification/application_service_api.rst b/specification/application_service_api.rst index 3220df2d..ee7e9de7 100644 --- 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 `_: Includes all changes since the latest versioned release. +- `r0.1.1 `_ - `r0.1.0 `_ diff --git a/specification/client_server_api.rst b/specification/client_server_api.rst index dd6e3246..9b16abc3 100644 --- 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:: diff --git a/specification/identity_service_api.rst b/specification/identity_service_api.rst index 88c7a8ab..89604644 100644 --- 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 `_: Includes all changes since the latest versioned release. +- `r0.2.0 `_ - `r0.1.0 `_ 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 diff --git a/specification/modules/end_to_end_encryption.rst b/specification/modules/end_to_end_encryption.rst index 62881967..36336c74 100644 --- 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. diff --git a/specification/modules/send_to_device.rst b/specification/modules/send_to_device.rst index cca0338a..7ab622bc 100644 --- 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: diff --git a/specification/modules/third_party_invites.rst b/specification/modules/third_party_invites.rst index b8ab9657..282b06f4 100644 --- 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 diff --git a/specification/rooms/v1.rst b/specification/rooms/v1.rst index e8cbf663..b5ef217a 100644 --- 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 diff --git a/specification/rooms/v2.rst b/specification/rooms/v2.rst index 247f6909..4e8365bf 100644 --- 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 +++++++++++++++ diff --git a/specification/rooms/v3.rst b/specification/rooms/v3.rst index 733c6984..8ef52acc 100644 --- a/specification/rooms/v3.rst +++ b/specification/rooms/v3.rst @@ -120,5 +120,5 @@ The remaining rules are the same as `room version 1 `_ -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. diff --git a/specification/server_server_api.rst b/specification/server_server_api.rst index d608965b..03c624ab 100644 --- 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 `_: Includes all changes since the latest versioned release. +- `r0.1.2 `_ - `r0.1.1 `_ - `r0.1.0 `_