Skip to content

Commit 430abd5

Browse files
committed
docs(be): add description for db field
1 parent ed18a33 commit 430abd5

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

db/AccessKey.go

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,12 @@ type AccessKey struct {
5555

5656
Owner AccessKeyOwner `db:"owner" json:"owner,omitempty"`
5757

58-
SourceStorageID *int `db:"source_storage_id" json:"source_storage_id,omitempty" backup:"-"`
58+
// SourceStorageID represents the ID of the source storage associated with the access key, used for reference purposes.
59+
SourceStorageID *int `db:"source_storage_id" json:"source_storage_id,omitempty" backup:"-"`
60+
61+
// SourceStorageKey is an optional reference to a specific storage key associated with the source storage.
62+
// For example for Hashicorp vault this is the path to the secret.
63+
// If SourceStorageID is nil, this field is references to an environment variable.
5964
SourceStorageKey *string `db:"source_storage_key" json:"source_storage_key,omitempty"`
6065
}
6166

0 commit comments

Comments
 (0)