chore(usage): add owner and user type in resource data (#232)

Because - differentiate `orgs` and `users` type trigger data This commit - add type for `user` and `owner` for each resource
instill-ai · Dec 6, 2023 · 857665d · 857665d
1 parent 153c3da
commit 857665d
Show file tree

Hide file tree

Showing 2 changed files with 83 additions and 17 deletions.
diff --git a/core/usage/v1beta/usage.proto b/core/usage/v1beta/usage.proto
@@ -102,19 +102,25 @@ message ConnectorUsageData {
     message ConnectorExecuteData {
       // UID for the executed connector
       string connector_uid = 1 [(google.api.field_behavior) = REQUIRED];
-      // UID for the trigger log
+      // UID for the execute log
       string execute_uid = 2 [(google.api.field_behavior) = REQUIRED];
       // Timestamp for the execution
       google.protobuf.Timestamp execute_time = 3 [(google.api.field_behavior) = REQUIRED];
       // Definition UID of the connector
       string connector_definition_uid = 4 [(google.api.field_behavior) = REQUIRED];
       // Final status of the execution
       core.mgmt.v1beta.Status status = 5 [(google.api.field_behavior) = REQUIRED];
+      // UUID of the user who execute the connector
+      string user_uid = 8 [(google.api.field_behavior) = REQUIRED];
+      // Type of the user who execute the connector
+      core.mgmt.v1beta.OwnerType user_type = 9 [(google.api.field_behavior) = REQUIRED];
     }
-    // User UUID
-    string user_uid = 1 [(google.api.field_behavior) = REQUIRED];
+    // Owner UUID
+    string owner_uid = 1 [(google.api.field_behavior) = REQUIRED];
     // Execution data for each user
     repeated ConnectorExecuteData connector_execute_data = 2 [(google.api.field_behavior) = REQUIRED];
+    // Owner type
+    core.mgmt.v1beta.OwnerType owner_type = 3 [(google.api.field_behavior) = REQUIRED];
   }
   // Usage data of all users in the connector service
   repeated UserUsageData usages = 1;
@@ -138,11 +144,17 @@ message ModelUsageData {
       common.task.v1alpha.Task model_task = 5 [(google.api.field_behavior) = REQUIRED];
       // Final status of the execution
       core.mgmt.v1beta.Status status = 6 [(google.api.field_behavior) = REQUIRED];
+      // UUID of the user who trigger the model
+      string user_uid = 7 [(google.api.field_behavior) = REQUIRED];
+      // Type of the user who trigger the model
+      core.mgmt.v1beta.OwnerType user_type = 8 [(google.api.field_behavior) = REQUIRED];
     }
-    // User UUID
-    string user_uid = 1 [(google.api.field_behavior) = REQUIRED];
+    // Owner UUID
+    string owner_uid = 1 [(google.api.field_behavior) = REQUIRED];
     // Trigger data for each user
     repeated ModelTriggerData model_trigger_data = 2 [(google.api.field_behavior) = REQUIRED];
+    // Owner type
+    core.mgmt.v1beta.OwnerType owner_type = 3 [(google.api.field_behavior) = REQUIRED];
   }
   // Usage data of all users in the model service
   repeated UserUsageData usages = 1;
@@ -168,11 +180,17 @@ message PipelineUsageData {
       string pipeline_release_id = 6 [(google.api.field_behavior) = REQUIRED];
       // UID for the triggered release pipeline, empty string if not release
       string pipeline_release_uid = 7 [(google.api.field_behavior) = REQUIRED];
+      // UUID of the user who trigger the pipeline
+      string user_uid = 8 [(google.api.field_behavior) = REQUIRED];
+      // Type of the user who trigger the pipeline
+      core.mgmt.v1beta.OwnerType user_type = 9 [(google.api.field_behavior) = REQUIRED];
     }
-    // User UUID
-    string user_uid = 1 [(google.api.field_behavior) = REQUIRED];
+    // Owner UUID
+    string owner_uid = 1 [(google.api.field_behavior) = REQUIRED];
     // Trigger data for each user
     repeated PipelineTriggerData pipeline_trigger_data = 2 [(google.api.field_behavior) = REQUIRED];
+    // Owner type
+    core.mgmt.v1beta.OwnerType owner_type = 3 [(google.api.field_behavior) = REQUIRED];
   }
   // Usage data of all users in the pipeline service
   repeated UserUsageData usages = 1;

diff --git a/openapiv2/openapiv2.swagger.yaml b/openapiv2/openapiv2.swagger.yaml
@@ -6353,7 +6353,7 @@ definitions:
         title: UID for the executed connector
       execute_uid:
         type: string
-        title: UID for the trigger log
+        title: UID for the execute log
       execute_time:
         type: string
         format: date-time
@@ -6364,13 +6364,21 @@ definitions:
       status:
         $ref: '#/definitions/mgmtv1betaStatus'
         title: Final status of the execution
+      user_uid:
+        type: string
+        title: UUID of the user who execute the connector
+      user_type:
+        $ref: '#/definitions/v1betaOwnerType'
+        title: Type of the user who execute the connector
     title: Per execute usage metadata
     required:
       - connector_uid
       - execute_uid
       - execute_time
       - connector_definition_uid
       - status
+      - user_uid
+      - user_type
   UserUsageDataModelTriggerData:
     type: object
     properties:
@@ -6393,6 +6401,12 @@ definitions:
       status:
         $ref: '#/definitions/mgmtv1betaStatus'
         title: Final status of the execution
+      user_uid:
+        type: string
+        title: UUID of the user who trigger the model
+      user_type:
+        $ref: '#/definitions/v1betaOwnerType'
+        title: Type of the user who trigger the model
     title: Per trigger usage metadata
     required:
       - model_uid
@@ -6401,6 +6415,8 @@ definitions:
       - model_definition_uid
       - model_task
       - status
+      - user_uid
+      - user_type
   UserUsageDataPipelineTriggerData:
     type: object
     properties:
@@ -6426,6 +6442,12 @@ definitions:
       pipeline_release_uid:
         type: string
         title: UID for the triggered release pipeline, empty string if not release
+      user_uid:
+        type: string
+        title: UUID of the user who trigger the pipeline
+      user_type:
+        $ref: '#/definitions/v1betaOwnerType'
+        title: Type of the user who trigger the pipeline
     title: Per trigger usage metadata
     required:
       - pipeline_uid
@@ -6435,6 +6457,8 @@ definitions:
       - status
       - pipeline_release_id
       - pipeline_release_uid
+      - user_uid
+      - user_type
   controllerv1alphaDeleteResourceResponse:
     type: object
     title: DeleteResourceResponse represents an empty response
@@ -8704,19 +8728,23 @@ definitions:
   v1betaConnectorUsageDataUserUsageData:
     type: object
     properties:
-      user_uid:
+      owner_uid:
         type: string
-        title: User UUID
+        title: Owner UUID
       connector_execute_data:
         type: array
         items:
           type: object
           $ref: '#/definitions/UserUsageDataConnectorExecuteData'
         title: Execution data for each user
+      owner_type:
+        $ref: '#/definitions/v1betaOwnerType'
+        title: Owner type
     title: Per user usage data in the connector service
     required:
-      - user_uid
+      - owner_uid
       - connector_execute_data
+      - owner_type
   v1betaConnectorView:
     type: string
     enum:
@@ -9984,19 +10012,23 @@ definitions:
   v1betaModelUsageDataUserUsageData:
     type: object
     properties:
-      user_uid:
+      owner_uid:
         type: string
-        title: User UUID
+        title: Owner UUID
       model_trigger_data:
         type: array
         items:
           type: object
           $ref: '#/definitions/UserUsageDataModelTriggerData'
         title: Trigger data for each user
+      owner_type:
+        $ref: '#/definitions/v1betaOwnerType'
+        title: Owner type
     title: Per user usage data in the model service
     required:
-      - user_uid
+      - owner_uid
       - model_trigger_data
+      - owner_type
   v1betaModelUsageRecord:
     type: object
     properties:
@@ -10181,6 +10213,18 @@ definitions:
     title: Membership represents the content of a membership
     required:
       - role
+  v1betaOwnerType:
+    type: string
+    enum:
+      - OWNER_TYPE_UNSPECIFIED
+      - OWNER_TYPE_USER
+      - OWNER_TYPE_ORGANIZATION
+    default: OWNER_TYPE_UNSPECIFIED
+    description: |-
+      - OWNER_TYPE_UNSPECIFIED: OwnerType: UNSPECIFIED
+       - OWNER_TYPE_USER: OwnerType: USER
+       - OWNER_TYPE_ORGANIZATION: OwnerType: ORGANIZATION
+    title: OwnerType enumerates the owner type of any resource
   v1betaPatchAuthenticatedUserResponse:
     type: object
     properties:
@@ -10467,19 +10511,23 @@ definitions:
   v1betaPipelineUsageDataUserUsageData:
     type: object
     properties:
-      user_uid:
+      owner_uid:
         type: string
-        title: User UUID
+        title: Owner UUID
       pipeline_trigger_data:
         type: array
         items:
           type: object
           $ref: '#/definitions/UserUsageDataPipelineTriggerData'
         title: Trigger data for each user
+      owner_type:
+        $ref: '#/definitions/v1betaOwnerType'
+        title: Owner type
     title: Per user usage data in the pipeline service
     required:
-      - user_uid
+      - owner_uid
       - pipeline_trigger_data
+      - owner_type
   v1betaPipelineUsageRecord:
     type: object
     properties: