protos: updated protos for metadata management (#309)

Metadata has been added to all resources. Updated all endpoints with metadata changes

Author: bgfreeman7

protos/sift/annotations/v1/annotations.proto

@@ -7,6 +7,8 @@ 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/common/type/v1/user.proto";
+import "sift/metadata/v1/metadata.proto";
 
 
 option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
@@ -34,7 +36,9 @@ service AnnotationService {
     };
   }
 
-  // Deletes an annotation.
+  // Delete Annotation is deprecated. Calling this will archive the annotation, which should be done using the
+  // UpdateAnnotation method with the delete date set to a non-null value. Restoring an annotation can be done
+  // by calling UpdateAnnotation with the delete date set to a null value.
   rpc DeleteAnnotation(DeleteAnnotationRequest) returns (DeleteAnnotationResponse) {
     option (google.api.http) = {delete: "/api/v1/annotations/{annotation_id}"};
     option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
@@ -43,7 +47,8 @@ service AnnotationService {
     };
   }
 
-  // Batch deletes annotations.
+  // BatchDeleteAnnotations will archive the annotations specified in the request. These can be restored
+  // by calling UpdateAnnotation with the delete date set to a null value.
   rpc BatchDeleteAnnotations(BatchDeleteAnnotationsRequest) returns (BatchDeleteAnnotationsResponse) {
     option (google.api.http) = {
       post: "/api/v1/annotations:batchDelete",
@@ -110,6 +115,12 @@ message Annotation {
   // An annotation is pending if it is part of an ongoing violation of a rule condition.
   // The `end_time` of a pending annotation might be set, but is not yet finalized.
   bool pending = 20 [(google.api.field_behavior) = OUTPUT_ONLY];
+  sift.common.type.v1.User assigned_to_user = 21 [(google.api.field_behavior) = OUTPUT_ONLY];
+  google.protobuf.Timestamp deleted_date = 22 [(google.api.field_behavior) = OPTIONAL];
+
+  repeated AnnotationLinkedChannel linked_channels = 23 [(google.api.field_behavior) = OPTIONAL];
+  repeated string asset_ids = 24 [(google.api.field_behavior) = OPTIONAL];
+  repeated sift.metadata.v1.MetadataValue metadata = 25 [(google.api.field_behavior) = OPTIONAL];
 }
 
 enum AnnotationState {
@@ -175,6 +186,8 @@ message CreateAnnotationRequest {
   optional string legend_config = 13 [(google.api.field_behavior) = OPTIONAL];
   // The ID of the rule condition version that created this annotation.
   optional string created_by_rule_condition_version_id = 15 [(google.api.field_behavior) = OPTIONAL];
+  // The metadata associated with this annotation.
+  repeated sift.metadata.v1.MetadataValue metadata = 16 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // The result of a call to `AnnotationService_CreateAnnotation`.
@@ -223,7 +236,7 @@ message ListAnnotationsRequest {
   // A [Common Expression Language (CEL)](https://github.com/google/cel-spec) filter string.
   // Available fields to filter by are `annotation_id`, `start_time`, `end_time`,
   // `created_date`, `modified_date`, `run_id`, `name`, `description`, `state`, `created_by_user_id`, `created_by_rule_condition_version_id`,
-  // `annotation_type`, `tag_name`, `report_id`, `asset_id`, `asset_name`, `pending`, and `assignee`.
+  // `annotation_type`, `tag_name`, `report_id`, `asset_id`, `asset_name`, `pending`, `assignee`, `campaign_reports`, and `metadata`.
   // 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/annotations#annotation). Optional.
   string filter = 3 [(google.api.field_behavior) = OPTIONAL];
@@ -232,8 +245,8 @@ message ListAnnotationsRequest {
   string organization_id = 4 [(google.api.field_behavior) = OPTIONAL];
 
   // How to order the retrieved annotations. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...".
-  // Available fields to order_by are `created_date`, `modified_date`, `start_time`, and `end_time`.
-  // If left empty, items are ordered by `created_date` in ascending order (oldest-first).
+  // Available fields to order_by are `created_date`, `modified_date`, `start_time`, `end_time`, `name`, and `description`.
+  // 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 = 5 [(google.api.field_behavior) = OPTIONAL];
@@ -252,7 +265,7 @@ message UpdateAnnotationRequest {
   Annotation annotation = 1 [(google.api.field_behavior) = REQUIRED];
 
   // The list of fields to be updated. The fields available to be updated are `name`, `description`, `start_time`,
-  // `end_time`, `assigned_to_user_id`, `state`, and `tags`.
+  // `end_time`, `assigned_to_user_id`, `state`, `tags`, `legend_config`, `linked_channels`, and `metadata`.
   // Important Note: if `tags` is specified in the update mask and `annotation.tags` is an empty list then all associated tags on the annotation
   // will be removed.
   google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];

protos/sift/calculated_channels/v2/calculated_channels.proto

@@ -10,6 +10,8 @@ import "protoc-gen-openapiv2/options/annotations.proto";
 import "sift/calculated_channels/v1/calculated_channels.proto";
 import "sift/common/type/v1/channel_data_type.proto";
 import "sift/common/type/v1/resource_identifier.proto";
+import "sift/common/type/v1/user_defined_functions.proto";
+import "sift/metadata/v1/metadata.proto";
 
 
 
@@ -94,6 +96,15 @@ service CalculatedChannelService {
       description: "Resolve a batch of calculated channels into expressions with references"
     };
   }
+
+  // Retrieve the latest versions of calculated channels based on an optional filter.
+  rpc ListResolvedCalculatedChannels(ListResolvedCalculatedChannelsRequest) returns (ListResolvedCalculatedChannelsResponse) {
+    option (google.api.http) = {get: "/api/v2/calculated-channels/resolved"};
+    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
+      summary: "ListResolvedCalculatedChannels",
+      description: "Retrieve the latest versions of calculated channels based on an optional filter."
+    };
+  }
 }
 
 message CalculatedChannel {
@@ -114,6 +125,8 @@ message CalculatedChannel {
   CalculatedChannelConfiguration calculated_channel_configuration = 15 [(google.api.field_behavior) = REQUIRED];
   string created_by_user_id = 16 [(google.api.field_behavior) = REQUIRED];
   string modified_by_user_id = 17 [(google.api.field_behavior) = REQUIRED];
+  repeated sift.common.type.v1.FunctionDependency function_dependencies = 19 [(google.api.field_behavior) = REQUIRED];
+  repeated sift.metadata.v1.MetadataValue metadata = 20 [(google.api.field_behavior) = REQUIRED];
 }
 
 message CalculatedChannelConfiguration {
@@ -180,6 +193,7 @@ message CreateCalculatedChannelRequest {
   optional string units = 7 [(google.api.field_behavior) = OPTIONAL];
   optional string client_key = 4 [(google.api.field_behavior) = OPTIONAL];
   CalculatedChannelConfiguration calculated_channel_configuration = 5 [(google.api.field_behavior) = REQUIRED];
+  repeated sift.metadata.v1.MetadataValue metadata = 8 [(google.api.field_behavior) = REQUIRED];
 }
 
 message CreateCalculatedChannelResponse {
@@ -211,7 +225,7 @@ message ListCalculatedChannelsRequest {
 
   // How to order the retrieved calculated channels. 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).
+  // 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 = 5 [(google.api.field_behavior) = OPTIONAL];
@@ -232,7 +246,7 @@ message UpdateCalculatedChannelRequest {
   // The calculated channel to update.
   CalculatedChannel calculated_channel = 1 [(google.api.field_behavior) = REQUIRED];
 
-  // The list of fields to be updated. The fields available to be updated are `name`, `description`, `units`,
+  // The list of fields to be updated. The fields available to be updated are `name`, `description`, `units`, `metadata`,
   // `query_configuration`, `archived_date`, and `asset_configuration`.
   google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
 
@@ -264,7 +278,7 @@ message ListCalculatedChannelVersionsRequest {
   string page_token = 4 [(google.api.field_behavior) = OPTIONAL];
 
   // A [Common Expression Language (CEL)](https://github.com/google/cel-spec) filter string.
-  // Available fields to filter by are `calculated_channel_id`, `client_key`, `name`, `asset_id`, `asset_name`, `tag_id`, `tag_name`, `version`, and `archived_date.
+  // Available fields to filter by are `calculated_channel_id`, `client_key`, `name`, `asset_id`, `asset_name`, `tag_id`, `tag_name`, `version`, `archived_date`, and `metadata`.
   // 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/calculated_channels#calculated_channel). Optional.
   string filter = 5 [(google.api.field_behavior) = OPTIONAL];
@@ -308,24 +322,25 @@ message ResolveCalculatedChannelRequest {
   optional sift.common.type.v1.ResourceIdentifier run = 5 [(google.api.field_behavior) = OPTIONAL];
 }
 
-// The response of a call to `CalculatedChannelService_ResolveCalculatedChannel`.
-message ResolveCalculatedChannelResponse {
-  // A specific calculated channel including the asset and exact channels to query.
-  message ResolvedCalculatedChannel {
-    // The name of the specific asset that was resolved.
-    string asset_name = 1 [(google.api.field_behavior) = REQUIRED];
-    // The expression resolved including channel references.
-    sift.calculated_channels.v1.ExpressionRequest expression_request = 2 [(google.api.field_behavior) = REQUIRED];
-    sift.common.type.v1.ChannelDataType output_data_type = 3 [(google.api.field_behavior) = REQUIRED];
-  }
+// A specific calculated channel including the asset and exact channels to query.
+message ResolvedCalculatedChannel {
+  // The name of the specific asset that was resolved.
+  string asset_name = 1 [(google.api.field_behavior) = REQUIRED];
+  // The expression resolved including channel references.
+  sift.calculated_channels.v1.ExpressionRequest expression_request = 2 [(google.api.field_behavior) = REQUIRED];
+  sift.common.type.v1.ChannelDataType output_data_type = 3 [(google.api.field_behavior) = REQUIRED];
+  string asset_id = 4 [(google.api.field_behavior) = REQUIRED];
+}
 
-  // Any failure in resolution.
-  message UnresolvedCalculatedChannel {
-    // The name of the specific asset that was not resolved.
-    string asset_name = 1 [(google.api.field_behavior) = REQUIRED];
-    string error_message = 2 [(google.api.field_behavior) = REQUIRED];
-  }
+// Any failure in resolution.
+message UnresolvedCalculatedChannel {
+  // The name of the specific asset that was not resolved.
+  string asset_name = 1 [(google.api.field_behavior) = REQUIRED];
+  string error_message = 2 [(google.api.field_behavior) = REQUIRED];
+}
 
+// The response of a call to `CalculatedChannelService_ResolveCalculatedChannel`.
+message ResolveCalculatedChannelResponse {
   // If provided in the request, the calculated channel resolved.
   optional string calculated_channel_id = 1 [(google.api.field_behavior) = OPTIONAL];
   // All resolved calculated channels.
@@ -345,3 +360,47 @@ message BatchResolveCalculatedChannelsResponse {
   // All calculated channels that attempted resolution.
   repeated ResolveCalculatedChannelResponse responses = 1 [(google.api.field_behavior) = REQUIRED];
 }
+
+message ListResolvedCalculatedChannelsRequest {
+  // Assets or runs to get the resolved calculated channels for. At least one asset or run must be provided.
+  string asset_id = 1 [(google.api.field_behavior) = OPTIONAL];
+  string run_id = 2 [(google.api.field_behavior) = OPTIONAL];
+
+  // The maximum number of calculated channels to return. The service may return fewer than this value.
+  // If unspecified, at most 50 calculated channels will be returned. The maximum value is 1000; values above
+  // 1000 will be coerced to 1000. Optional.
+  uint32 page_size = 3 [(google.api.field_behavior) = OPTIONAL];
+
+  // A page token, received from a previous `ListCalculatedChannels` call.
+  // Provide this to retrieve the subsequent page.
+  // When paginating, all other parameters provided to `ListCalculatedChannels` must match
+  // the call that provided the page token. Optional.
+  string page_token = 4 [(google.api.field_behavior) = OPTIONAL];
+
+  // A [Common Expression Language (CEL)](https://github.com/google/cel-spec) filter string.
+  // Available fields to filter by are `calculated_channel_id`, `client_key`, `name`, `asset_id`, `asset_name`, `tag_id`, `tag_name`, `version`, and `archived_date.
+  // 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/calculated_channels#calculated_channel). Optional.
+  string filter = 5 [(google.api.field_behavior) = OPTIONAL];
+
+  // How to order the retrieved calculated channels. 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 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 = 6 [(google.api.field_behavior) = OPTIONAL];
+}
+
+message CalculatedChannelResolution {
+  // The calculated channel resolved.
+  optional CalculatedChannel calculated_channel = 1 [(google.api.field_behavior) = OPTIONAL];
+  // All resolved calculated channels.
+  repeated ResolvedCalculatedChannel resolved = 2 [(google.api.field_behavior) = REQUIRED];
+  // All assets with any issues in resolution.
+  repeated UnresolvedCalculatedChannel unresolved = 3 [(google.api.field_behavior) = REQUIRED];
+}
+
+message ListResolvedCalculatedChannelsResponse {
+  repeated CalculatedChannelResolution calculated_channel_resolutions = 1 [(google.api.field_behavior) = REQUIRED];
+  string next_page_token = 3 [(google.api.field_behavior) = OPTIONAL];
+}