-
Notifications
You must be signed in to change notification settings - Fork 57
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add ability to update the Identity Metadata name field. #956
Conversation
🦋 Changeset detectedLatest commit: 131db7c The changes in this PR will be included in the next version bump. This PR includes changesets to release 5 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
TBDocs Report ✅ No errors or warnings @web5/api
@web5/crypto
@web5/crypto-aws-kms
@web5/dids
@web5/credentials
TBDocs Report Updated at 2024-10-21T23:34:21Z |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #956 +/- ##
=======================================
Coverage 93.36% 93.36%
=======================================
Files 118 118
Lines 33751 33784 +33
Branches 2746 2753 +7
=======================================
+ Hits 31510 31543 +33
Misses 2200 2200
Partials 41 41
|
583359d
to
131db7c
Compare
This PR exposes the ability to update the
name
field within the Identity's Metadata.The reasoning behind exposing the specific field vs allowing the entire object to be updated is to prevent some pretty bad foot-guns.
For more context:
The
uri
field should always be the DID's URI, so this should remain unchanged.The
tenant
field is set to the Agent's DID, changing this would be a foot-gun and might render the identity un-readable.The
connectedDid
field is used to denote whether a DID is a delegated/connected DID and which DID it is acting on behalf of (the connectedDID).Since none of these other values should be changed, we expose a method to update a single field.