Merge pull request #797 from marcpfuller/path_secretname

refactor(mod): Refactor Secret DTO to rename Path property to SecretName
edgexfoundry · Feb 14, 2023 · 57cbd60 · 57cbd60
2 parents 5ded580 + 36dc869
commit 57cbd60
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 8 deletions.
diff --git a/clients/http/common_test.go b/clients/http/common_test.go
@@ -58,7 +58,7 @@ func TestVersion(t *testing.T) {
 func TestAddSecret(t *testing.T) {
 	expected := dtoCommon.BaseResponse{}
 	req := dtoCommon.NewSecretRequest(
-		"testPath",
+		"testSecretName",
 		[]dtoCommon.SecretDataKeyValue{
 			{Key: "username", Value: "tester"},
 			{Key: "password", Value: "123"},

diff --git a/dtos/common/secret.go b/dtos/common/secret.go
@@ -30,11 +30,11 @@ type SecretDataKeyValue struct {
 	Value string `json:"value" validate:"required"`
 }
 
-// SecretRequest is the request DTO for storing supplied secret at specified Path in the Secret Store
+// SecretRequest is the request DTO for storing supplied secret at a given SecretName in the Secret Store
 // See detail specified by the V2 API swagger in openapi/v2
 type SecretRequest struct {
 	BaseRequest `json:",inline"`
-	Path        string               `json:"path" validate:"required"`
+	SecretName  string               `json:"secretName" validate:"required"`
 	SecretData  []SecretDataKeyValue `json:"secretData" validate:"required,gt=0,dive"`
 }
 
@@ -48,7 +48,7 @@ func (sr *SecretRequest) Validate() error {
 func (sr *SecretRequest) UnmarshalJSON(b []byte) error {
 	var alias struct {
 		BaseRequest
-		Path       string
+		SecretName string
 		SecretData []SecretDataKeyValue
 	}
 
@@ -65,10 +65,10 @@ func (sr *SecretRequest) UnmarshalJSON(b []byte) error {
 	return nil
 }
 
-func NewSecretRequest(path string, secretData []SecretDataKeyValue) SecretRequest {
+func NewSecretRequest(secretName string, secretData []SecretDataKeyValue) SecretRequest {
 	return SecretRequest{
 		BaseRequest: NewBaseRequest(),
-		Path:        path,
+		SecretName:  secretName,
 		SecretData:  secretData,
 	}
 }
diff --git a/dtos/common/secret_test.go b/dtos/common/secret_test.go
@@ -35,7 +35,7 @@ var validRequest = SecretRequest{
 		RequestId:   TestUUID,
 		Versionable: NewVersionable(),
 	},
-	Path: "something",
+	SecretName: "something",
 	SecretData: []SecretDataKeyValue{
 		{Key: "username", Value: "User1"},
 		{Key: "password", Value: "password"},
@@ -52,7 +52,7 @@ var missingValueSecretData = []SecretDataKeyValue{
 
 func TestSecretsRequest_Validate(t *testing.T) {
 	validNoPath := validRequest
-	validNoPath.Path = ""
+	validNoPath.SecretName = ""
 	validWithPath := validRequest
 	validNoRequestId := validRequest
 	validNoRequestId.RequestId = ""