SMQ-3108 - Add support for public and private metadata for users and clients

apidocs/openapi/clients.yaml

@@ -943,10 +943,14 @@ components:
               example: bb7edb32-2eac-4aad-aebe-ed96fe073879
               minimum: 8
               description: Free-form account secret used for acquiring auth token(s).
-        metadata:
+        public_metadata:
           type: object
           example: { "model": "example" }
           description: Arbitrary, object-encoded client's data.
+        metadata:
+          type: object
+          example: { "model": "example" }
+          description: Arbitrary, object-encoded client's data, private to the client.
         status:
           type: string
           description: Client Status
@@ -1001,10 +1005,14 @@ components:
               type: string
               example: bb7edb32-2eac-4aad-aebe-ed96fe073879
               description: Client secret password.
-        metadata:
+        public_metadata:
           type: object
           example: { "model": "example" }
           description: Arbitrary, object-encoded client's data.
+        metadata:
+          type: object
+          example: { "model": "example" }
+          description: Arbitrary, object-encoded client's data, private to the client.
         status:
           type: string
           description: Client Status
@@ -1058,10 +1066,14 @@ components:
               type: string
               example: ""
               description: Client secret password.
-        metadata:
+        public_metadata:
           type: object
           example: { "model": "example" }
           description: Arbitrary, object-encoded client's data.
+        metadata:
+          type: object
+          example: { "model": "example" }
+          description: Arbitrary, object-encoded client's data, private to the client.
         status:
           type: string
           description: Client Status
@@ -1113,9 +1125,14 @@ components:
         metadata:
           type: object
           example: { "role": "general" }
-          description: Arbitrary, object-encoded client's data.
+          description: Arbitrary, object-encoded client's data, private to the client.
+        public_metadata:
+          type: object
+          example: { "role": "general" }
+          description: Arbitrary, object-encoded client's data.        
       required:
         - name
+        - public_metadata
         - metadata
 
     ClientTags:

apidocs/openapi/users.yaml

@@ -712,6 +712,10 @@ components:
             - username
             - secret
         metadata:
+          type: object
+          example: { "domain": "example.com" }
+          description: Arbitrary, object-encoded user's data private to the user.
+        public_metadata:
           type: object
           example: { "domain": "example.com" }
           description: Arbitrary, object-encoded user's data.
@@ -768,6 +772,10 @@ components:
               example: john_doe
               description: User's username for example john_doe for Mr John Doe.
         metadata:
+          type: object
+          example: { "address": "example" }
+          description: Arbitrary, object-encoded user's data private to the user.
+        public_metadata:
           type: object
           example: { "address": "example" }
           description: Arbitrary, object-encoded user's data.
@@ -1252,7 +1260,7 @@ components:
 
     Metadata:
       name: metadata
-      description: Metadata filter. Filtering is performed matching the parameter with metadata on top level. Parameter is json.
+      description: Metadata filter. Filtering is performed matching the parameter with public metadata on top level. Parameter is json.
       in: query
       schema:
         type: object
@@ -1334,7 +1342,7 @@ components:
             $ref: "#/components/schemas/UserReqObj"
 
     UserUpdateReq:
-      description: JSON-formated document describing the metadata and name of user to be update
+      description: JSON-formated document describing the name, metadata and public_metadata of user to be update
       required: true
       content:
         application/json:

cli/clients_test.go

@@ -305,6 +305,26 @@ func TestUpdateClientCmd(t *testing.T) {
 		client        smqsdk.Client
 		logType       outputLog
 	}{
+		{
+			desc: "update client name and public metadata successfully",
+			args: []string{
+				client.ID,
+				updateCmd,
+				newNameandMeta,
+				domainID,
+				token,
+			},
+			client: smqsdk.Client{
+				Name: "clientName",
+				PublicMetadata: map[string]any{
+					"role": "general",
+				},
+				ID:       client.ID,
+				DomainID: client.DomainID,
+				Status:   client.Status,
+			},
+			logType: entityLog,
+		},
 		{
 			desc: "update client name and metadata successfully",
 			args: []string{
@@ -317,9 +337,7 @@ func TestUpdateClientCmd(t *testing.T) {
 			client: smqsdk.Client{
 				Name: "clientName",
 				Metadata: map[string]any{
-					"metadata": map[string]any{
-						"role": "general",
-					},
+					"role": "general",
 				},
 				ID:       client.ID,
 				DomainID: client.DomainID,

cli/users_test.go

@@ -708,7 +708,7 @@ Available update options:
 			case len(tc.args) == 4: // Basic user update
 				sdkCall = sdkMock.On("UpdateUser", mock.Anything, mgsdk.User{
 					FirstName: "new name",
-					Metadata: mgsdk.Metadata{
+					PublicMetadata: mgsdk.Metadata{
 						"key": "value",
 					},
 				}, tc.args[3]).Return(tc.user, tc.sdkErr)

clients/api/http/endpoints.go

@@ -143,9 +143,10 @@ func updateClientEndpoint(svc clients.Service) endpoint.Endpoint {
 		}
 
 		cli := clients.Client{
-			ID:       req.id,
-			Name:     req.Name,
-			Metadata: req.Metadata,
+			ID:             req.id,
+			Name:           req.Name,
+			Metadata:       req.Metadata,
+			PublicMetadata: req.PublicMetadata,
 		}
 		client, err := svc.Update(ctx, session, cli)
 		if err != nil {