diff --git a/api/client-server/keys.yaml b/api/client-server/keys.yaml index 0ea52e4a6..cce0edca0 100644 --- a/api/client-server/keys.yaml +++ b/api/client-server/keys.yaml @@ -56,7 +56,7 @@ paths: One-time public keys for "pre-key" messages. The names of the properties should be in the format ``:``. The format of the key is determined - by the key algorithm. + by the `key algorithm <#key-algorithms>`_. May be absent if no new one-time keys are required. additionalProperties: @@ -299,6 +299,9 @@ paths: description: |- One-time keys for the queried devices. A map from user ID, to a map from devices to a map from ``:`` to the key object. + + See the `key algorithms <#key-algorithms>`_ section for information + on the Key Object format. additionalProperties: type: object additionalProperties: diff --git a/api/server-server/user_keys.yaml b/api/server-server/user_keys.yaml index 613948c35..ea59de2d0 100644 --- a/api/server-server/user_keys.yaml +++ b/api/server-server/user_keys.yaml @@ -72,6 +72,9 @@ paths: description: |- One-time keys for the queried devices. A map from user ID, to a map from devices to a map from ``:`` to the key object. + + See the Client-Server Key Algorithms section for more information on + the Key Object format. additionalProperties: type: object additionalProperties: