From 1ad5ff4179cfa2b62d6be47ad6ed8bde95ec2e41 Mon Sep 17 00:00:00 2001 From: Hubert Chathi Date: Wed, 10 Nov 2021 13:48:18 -0500 Subject: [PATCH] Key name is supposed to be optional, as per MSC2874 (#3481) --- changelogs/client_server/newsfragments/3481.clarification | 1 + content/client-server-api/modules/secrets.md | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) create mode 100644 changelogs/client_server/newsfragments/3481.clarification diff --git a/changelogs/client_server/newsfragments/3481.clarification b/changelogs/client_server/newsfragments/3481.clarification new file mode 100644 index 00000000..d16620ff --- /dev/null +++ b/changelogs/client_server/newsfragments/3481.clarification @@ -0,0 +1 @@ +Make `AesHmacSha2KeyDescription` consistent with `KeyDescription` in marking `name` as optional. diff --git a/content/client-server-api/modules/secrets.md b/content/client-server-api/modules/secrets.md index 0d33464e..1ef626c0 100644 --- a/content/client-server-api/modules/secrets.md +++ b/content/client-server-api/modules/secrets.md @@ -184,7 +184,7 @@ correctly entered the key, clients should: | Parameter | Type | Description | |-------------|--------|-----------------------------------------------------------------------------------------------------------------------------------| -| name | string | **Required.** The name of the key. | +| name | string | Optional. The name of the key. | | algorithm | string | **Required.** The encryption algorithm to be used for this key. Currently, only `m.secret_storage.v1.aes-hmac-sha2` is supported. | | passphrase | object | See [deriving keys from passphrases](#deriving-keys-from-passphrases) section for a description of this property. | | iv | string | The 16-byte initialization vector, encoded as base64. |