Skip to content
This repository has been archived by the owner on Mar 27, 2024. It is now read-only.

Commit

Permalink
docs: Updated storage interface documentation
Browse files Browse the repository at this point in the history
Updated the documentation for the Put method to indicate that in the set of tags used on a single Put call, those tags must have unique tag names. The reason for this is because several of our major storage implementations in aries-framework-go-ext have this implementation, so this note was added to help ensure consistent behaviour.

Signed-off-by: Derek Trider <Derek.Trider@securekey.com>
  • Loading branch information
Derek Trider committed Apr 11, 2022
1 parent be0a515 commit 7e99771
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions spi/storage/storage.go
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,7 @@ type Store interface {
// with data put in and data retrieved, as the marshalled representation may be different - always unmarshal data
// first before comparing.
// If key is empty or value is nil, then an error will be returned.
// A single key-value pair cannot have multiple tags that share the same tag name.
Put(key string, value []byte, tags ...Tag) error

// Get fetches the value associated with the given key.
Expand Down

0 comments on commit 7e99771

Please sign in to comment.