Skip to content
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

clarify when jwk.Set.RemoveKey can return error #1015

Merged
merged 1 commit into from
Nov 17, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions jwk/interface.go
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,9 @@ type Set interface {
// specify, and there is no way of knowing what type they could be.
Set(string, interface{}) error

// RemoveKey removes the specified non-key field from the set.
// Keys may not be removed using this method.
// Remove removes the specified non-key field from the set.
// Keys may not be removed using this method. See RemoveKey for
// removing keys.
Remove(string) error

// Index returns the index where the given key exists, -1 otherwise
Expand All @@ -101,6 +102,8 @@ type Set interface {
LookupKeyID(string) (Key, bool)

// RemoveKey removes the key from the set.
// RemoveKey returns an error when the specified key does not exist
// in set.
RemoveKey(Key) error

// Keys creates an iterator to iterate through all keys in the set.
Expand Down
Loading