chore(protos): Update for metadata (#230)

Author: Ailin Yu

protos/sift/assets/v1/assets.proto

@@ -7,6 +7,7 @@ import "google/api/field_behavior.proto";
 import "google/protobuf/field_mask.proto";
 import "google/protobuf/timestamp.proto";
 import "protoc-gen-openapiv2/options/annotations.proto";
+import "sift/metadata/v1/metadata.proto";
 
 
 option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
@@ -22,7 +23,7 @@ service AssetService {
     }
   };
 
-  // Deletes an asset.
+  // Delete will archive an asset.
   rpc DeleteAsset(DeleteAssetRequest) returns (DeleteAssetResponse) {
     option (google.api.http) = {delete: "/api/v1/assets/{asset_id}"};
     option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
@@ -70,8 +71,14 @@ message Asset {
   google.protobuf.Timestamp modified_date = 7 [(google.api.field_behavior) = REQUIRED];
   string modified_by_user_id = 8 [(google.api.field_behavior) = REQUIRED];
 
-  // The names of the tags to associate with this asset.
+  // The names of the tags associated with this asset.
   repeated string tags = 9 [(google.api.field_behavior) = REQUIRED];
+
+  // The metadata values associated with this asset.
+  repeated sift.metadata.v1.MetadataValue metadata = 10 [(google.api.field_behavior) = REQUIRED];
+
+  // The date the asset was archived.
+  google.protobuf.Timestamp archived_date = 11 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // The request for a call to `AssetService_ListAssets`.
@@ -90,14 +97,14 @@ message ListAssetsRequest {
 
   // A [Common Expression Language (CEL)](https://github.com/google/cel-spec) filter string.
   // Available fields to filter by are `asset_id`, `created_by_user_id`, `modified_by_user_id`,
-  // `created_date`, `modified_date`, and `name`.
+  // `created_date`, `modified_date`, `name`, `tag_id`, `tag_name`, and `metadata`. Metadata can be used in filters by using `metadata.{metadata_key_name}` as the field name.
   // For further information about how to use CELs, please refer to [this guide](https://github.com/google/cel-spec/blob/master/doc/langdef.md#standard-definitions).
   // For more information about the fields used for filtering, please refer to [this definition](/docs/api/grpc/protocol-buffers/assets#asset). Optional.
   string filter = 3 [(google.api.field_behavior) = OPTIONAL];
 
   // How to order the retrieved assets. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...".
-  // Available fields to order_by are `created_date` and `modified_date`.
-  // If left empty, items are ordered by `created_date` in ascending order (oldest-first).
+  // Available fields to order_by are `name`, `created_date` and `modified_date`.
+  // If left empty, items are ordered by `created_date` in descending order (newest-first).
   // For more information about the format of this field, read [this](https://google.aip.dev/132#ordering)
   // Example: "created_date desc,modified_date"
   string order_by = 4 [(google.api.field_behavior) = OPTIONAL];
@@ -109,10 +116,13 @@ message ListAssetsResponse {
   string next_page_token = 5;
 }
 
-// The request for a call to `AssetService_DeleteAsset` to delete a single existing annotation by its asset_id.
+// The request for a call to `AssetService_DeleteAsset` to archive a single existing asset by its asset_id.
 message DeleteAssetRequest {
-  // The id of the asset to be deleted. Required.
+  // The id of the asset to be archived. Required.
   string asset_id = 1 [(google.api.field_behavior) = REQUIRED];
+
+  // If true, will archive all runs associated with the asset.
+  bool archive_runs = 2 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // The response of a call to `AssetService_DeleteAsset`.
@@ -127,14 +137,18 @@ message GetAssetRequest {
 message GetAssetResponse {
   Asset asset = 1;
 }
+
+// The request for a call to `AssetService_UpdateAsset` to update a single existing asset.
 message UpdateAssetRequest {
   // The asset to update. The asset's `asset_id` field is used to identify asset run to update
   // and is required.
   Asset asset = 1;
 
-  // The list of fields to be updated. Currently, the only field available to be updated is `tags`.
+  // The list of fields to be updated. The fields available to be updated are `tags`, `metadata`, and `archived_date`.
   google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
 }
+
+// The response of a call to `AssetService_UpdateAsset`.
 message UpdateAssetResponse {
   Asset asset = 1;
 }

protos/sift/metadata/v1/metadata.proto

@@ -0,0 +1,104 @@
+syntax = "proto3";
+
+package sift.metadata.v1;
+
+import "google/api/annotations.proto";
+import "google/api/field_behavior.proto";
+import "protoc-gen-openapiv2/options/annotations.proto";
+
+
+option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
+  info: {title: "Metadata service"}
+};
+
+service MetadataService {
+  // Create a metadata key.
+  rpc CreateMetadataKey(CreateMetadataKeyRequest) returns (CreateMetadataKeyResponse) {
+    option (google.api.http) = {
+      post: "/api/v1/metadata-keys"
+      body: "*"
+    };
+    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
+      summary: "CreateMetadataKey",
+      description: "Create a metadata key."
+    };
+  }
+
+  // List metadata keys.
+  rpc ListMetadataKeys(ListMetadataKeysRequest) returns (ListMetadataKeysResponse) {
+    option (google.api.http) = {get: "/api/v1/metadata-keys"};
+    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
+      summary: "ListMetadataKeys"
+      description: "List metadata keys."
+    };
+  }
+}
+
+// Metadata key type.
+enum MetadataKeyType {
+  METADATA_KEY_TYPE_UNSPECIFIED = 0;
+  // string
+  METADATA_KEY_TYPE_STRING = 1;
+  // number
+  METADATA_KEY_TYPE_NUMBER = 2;
+  // boolean
+  METADATA_KEY_TYPE_BOOLEAN = 3;
+}
+
+message MetadataKey {
+  string name = 1 [(google.api.field_behavior) = REQUIRED];
+  MetadataKeyType type = 2 [(google.api.field_behavior) = REQUIRED];
+}
+
+message MetadataValue {
+  MetadataKey key = 1 [(google.api.field_behavior) = REQUIRED];
+  oneof value {
+    string string_value = 2;
+    double number_value = 3;
+    bool boolean_value = 4;
+  }
+}
+
+// The request of a call to `MetadataService_CreateMetadataKey` to create a metadata key.
+message CreateMetadataKeyRequest {
+  MetadataKey metadata_key = 1 [(google.api.field_behavior) = REQUIRED];
+}
+
+// The response of a call to `MetadataService_CreateMetadataKey` to create a metadata key.
+message CreateMetadataKeyResponse {
+  MetadataKey metadata_key = 1 [(google.api.field_behavior) = REQUIRED];
+}
+
+// The request for a call to `MetadataService_ListMetadataKeys` to retrieve metadata keys.
+message ListMetadataKeysRequest {
+  // The maximum number of metadata keys to return. The service may return fewer than this value.
+  // If unspecified, at most 50 metadata keys will be returned. The maximum value is 1000; values above
+  // 1000 will be coerced to 1000. Optional.
+  uint32 page_size = 1 [(google.api.field_behavior) = OPTIONAL];
+
+  // A page token, received from a previous `ListMetadataKeys` call.
+  // Provide this to retrieve the subsequent page.
+  // When paginating, all other parameters provided to `ListMetadataKeys` must match
+  // the call that provided the page token. Optional.
+  string page_token = 2 [(google.api.field_behavior) = OPTIONAL];
+
+  // A [Common Expression Language (CEL)](https://github.com/google/cel-spec) filter string.
+  // Available fields to filter by are:
+  // `name`.
+  // For further information about how to use CELs, please refer to [this guide](https://github.com/google/cel-spec/blob/master/doc/langdef.md#standard-definitions).
+  // For more information about the fields used for filtering, please refer to this definition. Optional.
+  string filter = 3 [(google.api.field_behavior) = OPTIONAL];
+
+  // How to order the retrieved metadata keys. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...".
+  // Available fields to order_by are `created_date` and `name`.
+  // If left empty, items are ordered by `created_date` in ascending order (oldest-first).
+  // For more information about the format of this field, read [this](https://google.aip.dev/132#ordering)
+  // Example: "created_date desc,modified_date"
+  string order_by = 4 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// The response of a call to `MetadataService_ListMetadataKeysResponse`.
+message ListMetadataKeysResponse {
+  repeated MetadataKey metadata_keys = 1;
+  string next_page_token = 2;
+}

protos/sift/runs/v2/runs.proto

@@ -7,6 +7,7 @@ import "google/api/field_behavior.proto";
 import "google/protobuf/field_mask.proto";
 import "google/protobuf/timestamp.proto";
 import "protoc-gen-openapiv2/options/annotations.proto";
+import "sift/metadata/v1/metadata.proto";
 
 
 option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
@@ -113,12 +114,18 @@ message Run {
   repeated string tags = 12 [(google.api.field_behavior) = REQUIRED];
   string default_report_id = 13 [(google.api.field_behavior) = OPTIONAL];
   optional string client_key = 14 [(google.api.field_behavior) = OPTIONAL];
+  // The metadata values associated with this run.
+  repeated sift.metadata.v1.MetadataValue metadata = 15 [(google.api.field_behavior) = REQUIRED];
+  repeated string asset_ids = 16 [(google.api.field_behavior) = REQUIRED];
+  optional google.protobuf.Timestamp archived_date = 17 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // The request for a call to `RunService_GetRun` to retrieve run.
 message GetRunRequest {
   // The ID of the run to retrieve.
-  string run_id = 1 [(google.api.field_behavior) = REQUIRED];
+  string run_id = 1 [
+    (google.api.field_behavior) = REQUIRED
+  ];
 }
 
 // The response of a call to `RunService_GetRun` containing the requested run.
@@ -142,14 +149,15 @@ message ListRunsRequest {
 
   // A [Common Expression Language (CEL)](https://github.com/google/cel-spec) filter string.
   // Available fields to filter by are `run_id`, `organization_id`, `name`, `description`, `created_by_user_id`, `modified_by_user_id`,
-  // `created_date`, `modified_date`, `start_time`, `stop_time`, `client_key`, `is_pinned`, `asset_id`, `client_key`, and `asset_name`.
+  // `created_date`, `modified_date`, `start_time`, `stop_time`, `client_key`, `is_pinned`, `asset_id`, `asset_name`, `archived_date`,
+  // and `metadata`. Metadata can be used in filters by using `metadata.{metadata_key_name}` as the field name.
   // For further information about how to use CELs, please refer to [this guide](https://github.com/google/cel-spec/blob/master/doc/langdef.md#standard-definitions).
   // For more information about the fields used for filtering, please refer to [this definition](/docs/api/grpc/protocol-buffers/runs#run). Optional.
   string filter = 3 [(google.api.field_behavior) = OPTIONAL];
 
   // How to order the retrieved runs. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...".
-  // Available fields to order_by are `created_date`, `modified_date`, `start_time`, and `stop_time`.
-  // If left empty, items are ordered by `created_date` in ascending order (oldest-first).
+  // Available fields to order_by are `name`, `description`, `created_date`, `modified_date`, `start_time`, and `stop_time`.
+  // If left empty, items are ordered by `created_date` in descending order (newest-first).
   // For more information about the format of this field, read [this](https://google.aip.dev/132#ordering)
   // Example: "created_date desc,modified_date"
   string order_by = 4 [(google.api.field_behavior) = OPTIONAL];
@@ -187,7 +195,12 @@ message CreateRunRequest {
   string organization_id = 7 [(google.api.field_behavior) = OPTIONAL];
 
   // An arbitrary user-chosen key that uniquely identifies this run. Optional, though it is recommended to provide.
-  optional string client_key = 8 [(google.api.field_behavior) = OPTIONAL];
+  optional string client_key = 8 [
+    (google.api.field_behavior) = OPTIONAL
+  ];
+
+  // The metadata values associated with this run.
+  repeated sift.metadata.v1.MetadataValue metadata = 9 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // The response of a call to `RunService_CreateRuns` containing the newly created run.
@@ -202,12 +215,14 @@ message UpdateRunRequest {
   Run run = 1 [(google.api.field_behavior) = REQUIRED];
 
   // The list of fields to be updated. The fields available to be updated are `name`, `description`,
-  // `start_time`, `stop_time`, `is_pinned`, `client_key`  and `tags`.
+  // `start_time`, `stop_time`, `is_pinned`, `client_key`, `tags`, and `metadata`.
   // Important Note: When updating the `start_time`, please be aware that if a subsequent data ingestion
   // commences for this run, the `start_time` will be automatically overwritten and set to the timestamp
   // corresponding to the beginning of the latest run. Additionally, `client_key` can only be set once either in run creation or in update.
   // Any subsequent attempt to update `client_key` will result in an error.
-  google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
+  google.protobuf.FieldMask update_mask = 2 [
+    (google.api.field_behavior) = REQUIRED
+  ];
 }
 
 // The response of a call to `RunService_UpdateRun` containing the updated run.
@@ -217,7 +232,9 @@ message UpdateRunResponse {
 
 message CreateAutomaticRunAssociationForAssetsRequest {
   // The ID of the run to associate the asset with.
-  string run_id = 1 [(google.api.field_behavior) = REQUIRED];
+  string run_id = 1 [
+    (google.api.field_behavior) = REQUIRED
+  ];
 
   // A list of asset names to automatically associate with the run.
   // Any data that is received for these assets will automatically added to the run.
@@ -233,15 +250,19 @@ message CreateAutomaticRunAssociationForAssetsResponse {}
 
 // The request for a call to `RunService_DeleteRun`.
 message DeleteRunRequest {
-  string run_id = 1 [(google.api.field_behavior) = REQUIRED];
+  string run_id = 1 [
+    (google.api.field_behavior) = REQUIRED
+  ];
 }
 
 // The response of a call to `RunService_DeleteRun`.
 message DeleteRunResponse {}
 
 // The request for a call to `RunService_StopRun` to stop a run.
 message StopRunRequest {
-  string run_id = 1 [(google.api.field_behavior) = REQUIRED];
+  string run_id = 1 [
+    (google.api.field_behavior) = REQUIRED
+  ];
 }
 
 // The response of a call to `RunService_StopRun` to stop a run.