From 583359d1b6b1e005b36643e9786fb439e9dcc347 Mon Sep 17 00:00:00 2001
From: Liran Cohen <c.liran.c@gmail.com>
Date: Mon, 21 Oct 2024 15:34:17 -0400
Subject: [PATCH] add changesets and comments

---
 .changeset/shy-grapes-juggle.md    | 8 ++++++++
 packages/agent/src/identity-api.ts | 8 ++++++++
 2 files changed, 16 insertions(+)
 create mode 100644 .changeset/shy-grapes-juggle.md

diff --git a/.changeset/shy-grapes-juggle.md b/.changeset/shy-grapes-juggle.md
new file mode 100644
index 000000000..4cb022f44
--- /dev/null
+++ b/.changeset/shy-grapes-juggle.md
@@ -0,0 +1,8 @@
+---
+"@web5/agent": patch
+"@web5/identity-agent": patch
+"@web5/proxy-agent": patch
+"@web5/user-agent": patch
+---
+
+Add ability to update the Identity Metadata name field.
diff --git a/packages/agent/src/identity-api.ts b/packages/agent/src/identity-api.ts
index 0c7c7c5b9..0b1bbd1cd 100644
--- a/packages/agent/src/identity-api.ts
+++ b/packages/agent/src/identity-api.ts
@@ -270,6 +270,14 @@ export class AgentIdentityApi<TKeyManager extends AgentKeyManager = AgentKeyMana
     await this.agent.did.update({ portableDid, tenant: this.agent.agentDid.uri });
   }
 
+  /**
+   * Updates the Identity's metadata name field.
+   *
+   * @param didUri - The DID URI of the Identity to update.
+   * @param name - The new name to set for the Identity.
+   *
+   * @throws An error if the Identity is not found, name is not provided, or no changes are detected.
+   */
   public async setMetadataName({ didUri, name }: { didUri: string; name: string }): Promise<void> {
     if (!name) {
       throw new Error('AgentIdentityApi: Failed to set metadata name due to missing name value.');