@@ -262,9 +262,10 @@ extension`_.
262
262
Extensions to ``m.message `` msgtypes
263
263
<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
264
264
265
- This module adds ``file `` and ``thumbnail_file `` properties to ``m.message ``
266
- msgtypes that reference files, such as ``m.file `` and ``m.image ``, replacing
267
- the ``url `` and ``thumbnail_url `` properties.
265
+ This module adds ``file `` and ``thumbnail_file `` properties, of type
266
+ ``EncryptedFile ``, to ``m.message `` msgtypes that reference files, such as
267
+ `m.file `_ and `m.image `_, replacing the ``url `` and ``thumbnail_url ``
268
+ properties.
268
269
269
270
.. todo: generate this from a swagger definition?
270
271
@@ -273,29 +274,30 @@ the ``url`` and ``thumbnail_url`` properties.
273
274
========= ================ =====================================================
274
275
Parameter Type Description
275
276
========= ================ =====================================================
276
- url string The URL to the file.
277
- key JWK A `JSON Web Key `_ object.
278
- iv string The Initialisation Vector used by AES-CTR, encoded as
279
- unpadded base64.
280
- hashes {string: string} A map from an algorithm name to a hash of the
281
- ciphertext, encoded as unpadded base64. Clients
277
+ url string ** Required. ** The URL to the file.
278
+ key JWK ** Required. ** A `JSON Web Key `_ object.
279
+ iv string ** Required. ** The Initialisation Vector used by
280
+ AES-CTR, encoded as unpadded base64.
281
+ hashes {string: string} ** Required. ** A map from an algorithm name to a hash
282
+ of the ciphertext, encoded as unpadded base64. Clients
282
283
should support the SHA-256 hash, which uses the key
283
284
``sha256 ``.
284
- v string Version of the encrypted attachments protocol. Must
285
- be ``v2 ``.
285
+ v string ** Required. ** Version of the encrypted attachments
286
+ protocol. Must be ``v2 ``.
286
287
========= ================ =====================================================
287
288
288
289
``JWK ``
289
290
290
291
========= ========= ============================================================
291
292
Parameter Type Description
292
293
========= ========= ============================================================
293
- key string Key type. Must be ``oct ``.
294
- key_opts [string] Key operations. Must at least contain ``encrypt `` and
295
- ``decrypt ``.
296
- alg string Algorithm. Must be ``A256CTR ``.
297
- k string The key, encoded as urlsafe unpadded base64.
298
- ext boolean Extractable. Must be ``true ``. This is a `W3C extension `_.
294
+ key string **Required. ** Key type. Must be ``oct ``.
295
+ key_opts [string] **Required. ** Key operations. Must at least contain
296
+ ``encrypt `` and ``decrypt ``.
297
+ alg string **Required. ** Algorithm. Must be ``A256CTR ``.
298
+ k string **Required. ** The key, encoded as urlsafe unpadded base64.
299
+ ext boolean **Required. ** Extractable. Must be ``true ``. This is a
300
+ `W3C extension `_.
299
301
========= ========= ============================================================
300
302
301
303
Example:
0 commit comments