Skip to content

Commit

Permalink
Updating API descriptions (#65)
Browse files Browse the repository at this point in the history
chore: Update protofetch.toml
  • Loading branch information
celaus authored Oct 14, 2024
1 parent 6bc3484 commit bf7f499
Show file tree
Hide file tree
Showing 12 changed files with 157 additions and 32 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,15 @@ service DatasetLocationsService {
}
}

service InternalDatasetLocationsService {
rpc GetDatasetLocations(InternalDatasetLocationsServiceGetDatasetLocationsRequest) returns (InternalDatasetLocationsServiceGetDatasetLocationsResponse) {
option (com.coralogix.archive.v1.audit_log_description).description = "Get dataset locations by team_id, dataspace, dataset and timeframe";
}
rpc GetDatasetList(InternalDatasetLocationsServiceGetDatasetListRequest) returns (InternalDatasetLocationsServiceGetDatasetListResponse) {
option (com.coralogix.archive.v1.audit_log_description).description = "Get dataset list according to company id";
}
}

message Timeframe {
google.protobuf.Timestamp start_time = 1;
google.protobuf.Timestamp end_time = 2;
Expand All @@ -26,6 +35,11 @@ message GetDatasetLocationsRequest {

}

message InternalDatasetLocationsServiceGetDatasetLocationsRequest {
repeated DatasetLocationRequest datasets_locations = 1;

}

message DatasetLocationRequest {
repeated uint32 company_ids = 1;
string dataspace_regex = 2;
Expand All @@ -37,6 +51,10 @@ message GetDatasetLocationsResponse {
repeated DatasetLocations dataset_locations = 1;
}

message InternalDatasetLocationsServiceGetDatasetLocationsResponse {
repeated DatasetLocations dataset_locations = 1;
}

message DatasetLocations {
repeated DatasetLocation locations = 1;
}
Expand All @@ -52,6 +70,9 @@ message DatasetLocation {
message GetDatasetListRequest {
repeated uint32 company_ids = 1;
}
message InternalDatasetLocationsServiceGetDatasetListRequest {
repeated uint32 company_ids = 1;
}

message DatasetsInfo {
uint32 company_id = 1;
Expand All @@ -60,4 +81,8 @@ message DatasetsInfo {

message GetDatasetListResponse {
repeated DatasetsInfo datasets_info = 1;
}

message InternalDatasetLocationsServiceGetDatasetListResponse {
repeated DatasetsInfo datasets_info = 1;
}
39 changes: 32 additions & 7 deletions proto/com/coralogix/catalog/v1/error_tracking_service.proto
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ enum Source {
message GetServiceErrorTrackingOverviewRequest {
com.coralogixapis.apm.common.v2.TimeRange time_range = 1;
google.protobuf.StringValue service_name = 2;
repeated ApmFilter filters = 3;
repeated ApmFilter service_catalog_filters = 3;
GroupBy group_by = 4;
google.protobuf.Int64Value trend_offset = 5;
Source source = 6;
repeated com.coralogixapis.service_catalog.v1.SpanKind span_kinds = 7;
repeated com.coralogixapis.service_catalog.v1.SpanKind operation_span_kinds = 7;
com.coralogixapis.service_catalog.v1.ApmSource apm_source = 8;
google.protobuf.UInt64Value topk = 9;
}
Expand All @@ -48,21 +48,42 @@ message GetServiceErrorTrackingOverviewResponse {
message GetServiceErrorTrackingListRequest {
com.coralogixapis.apm.common.v2.TimeRange time_range = 1;
google.protobuf.StringValue service_name = 2;
repeated ApmFilter filters = 3;
repeated ApmFilter service_catalog_filters = 3;
GroupBy group_by = 4;
google.protobuf.Int64Value trend_offset = 5;
Source source = 6;
repeated com.coralogixapis.service_catalog.v1.SpanKind span_kinds = 7;
repeated com.coralogixapis.service_catalog.v1.SpanKind operation_span_kinds = 7;
com.coralogixapis.service_catalog.v1.ApmSource apm_source = 8;
}

message GetServiceErrorOperationsListRequest {
com.coralogixapis.apm.common.v2.TimeRange time_range = 1;
google.protobuf.StringValue service_name = 2;
repeated ApmFilter service_catalog_filters = 3;
GroupBy group_by = 4;
Source source = 5;
repeated com.coralogixapis.service_catalog.v1.SpanKind span_kinds = 6;
com.coralogixapis.service_catalog.v1.ApmSource apm_source = 7;
google.protobuf.StringValue error_message = 8;
}

message OperationDetails {
google.protobuf.StringValue operation = 1;
google.protobuf.Int64Value occurrences = 2;
}

message GetServiceErrorOperationsListResponse {
repeated OperationDetails operationDetails = 1;
}

message GetServiceErrorTrackingListResponse {
repeated ErrorDetails error_details = 1;
GroupBy group_by = 2;
google.protobuf.StringValue query = 1;
repeated ErrorDetails error_details = 2;
GroupBy group_by = 3;
}

message Operations {
repeated google.protobuf.StringValue operations = 1;
map<string, google.protobuf.Int64Value> operations = 1;
}

message ErrorDetails {
Expand All @@ -84,4 +105,8 @@ service ErrorTrackingService {
rpc GetServiceErrorTrackingListStream(GetServiceErrorTrackingListRequest) returns (stream GetServiceErrorTrackingListResponse) {
option (com.coralogixapis.apm.common.v2.audit_log_description).description = "get service error tracking list";
}

rpc GetServiceErrorOperationsList(GetServiceErrorOperationsListRequest) returns (GetServiceErrorOperationsListResponse) {
option (com.coralogixapis.apm.common.v2.audit_log_description).description = "get service error operations list";
}
}
2 changes: 1 addition & 1 deletion proto/com/coralogix/dataprime/ast/v1/ast.proto
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import "com/coralogix/dataprime/ast/v1/query.proto";

message Ast {
Query query = 1;
TimeRange time_range = 2 [deprecated = true];
reserved 2; // was time_range
}

message DdlAst {
Expand Down
2 changes: 2 additions & 0 deletions proto/com/coralogix/dataprime/ast/v1/query.proto
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@ message TimeFrame {

message Schema {
string name = 1;
optional string team_id = 2;
optional TimeFrame time_frame = 3;
}

message Operator {
Expand Down
4 changes: 1 addition & 3 deletions proto/com/coralogix/dataprime/v1/internal_metadata.proto
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ message MetadataEnums {
}

message QueryMetadata {
reserved 6; // formerly skip_rbac_filters
// beginning of the time range for the query
optional google.protobuf.Timestamp start_date = 1;
// end of the time range for the query
Expand All @@ -30,9 +31,6 @@ message QueryMetadata {
optional int32 limit = 4;
// dataprime strict fields validation in parser
optional bool strict_fields_validation = 5;
// skip application and subsystem filters based on user scopes from RBAC.
// WARNING: if you set this flag, you are responsible for managing access to the data.
optional bool skip_rbac_filters = 6;
// contextual `now` for the query, default: current time
optional google.protobuf.Timestamp now_date = 7;
}
Expand Down
69 changes: 68 additions & 1 deletion proto/com/coralogix/dataprime/v1/query.proto
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ message QuerySource {

message SchemaStoreSource {
repeated string team_ids = 1;
string name = 2;
}

oneof source {
Expand All @@ -103,10 +104,76 @@ message QuerySource {
reserved 3, 4;
}

message PhysicalLocation {
enum Partitioning {
PARTITIONING_UNSPECIFIED = 0;
PARTITIONING_NONE = 1;
PARTITIONING_DT_HR = 2;
}

enum Format {
FORMAT_UNSPECIFIED = 0;
FORMAT_CSV = 1;
FORMAT_WIDE_PARQUET_V1 = 2;
FORMAT_WIDE_PARQUET_V3 = 3;
}

enum BucketType {
BUCKET_TYPE_UNSPECIFIED = 0;
BUCKET_TYPE_EXTERNAL = 1;
BUCKET_TYPE_INTERNAL = 2;
}

message S3Location {
string region = 1;
string bucket = 2;
// Absolute path, root is represented by `/`
string prefix = 3;
}

message COSLocation {
string endpoint = 1;
string bucket = 2;
// Absolute path, root is represented by `/`
string prefix = 3;
BucketType bucket_type = 4;
}

message ObjectStoreLocation {
Format format = 1;
oneof location {
S3Location s3 = 2;
COSLocation cos = 3;
}
}

message ArchiveLocation {
Partitioning partitioning = 1;
repeated ObjectStoreLocation locations = 2;
}

message OpenSearchLocation {
string host = 1;
string index = 2;
}

message SchemaStoreLocation {
repeated string team_ids = 1;
}

oneof location {
ArchiveLocation archive = 1;
OpenSearchLocation open_search = 2;
SchemaStoreLocation schema_store = 3;
}
}

message NamedQuerySource {
reserved 1;
com.coralogix.dataprime.ast.v1.Source name = 3;
QuerySource source = 2;
// Use `physical_location` instead
QuerySource source = 2 [deprecated = true];
PhysicalLocation physical_location = 4;
}

message SubmitQueryResponse {
Expand Down
1 change: 1 addition & 0 deletions proto/com/coralogix/extensions/v1/extension.proto
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ enum TargetDomain {
CX_CUSTOM_DASHBOARD = 8;
METRICS_RULE_GROUP = 9;
EVENTS_TO_METRICS = 10;
ALERT_V3 = 11;
}

message ExtensionItemBinary {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ message Permission {
ActionId action = 2;
}

message PermissionId {
google.protobuf.UInt32Value id = 1;
}

service PermissionCheckService {

rpc CheckApiKeyPermission(CheckApiKeyPermissionRequest) returns (CheckApiKeyPermissionResponse) {
Expand All @@ -39,9 +43,10 @@ service PermissionCheckService {

}

message CheckApiKeyPermissionRequest{
Permission permission = 1;
message CheckApiKeyPermissionRequest {
Permission permission = 1 [deprecated = true];
ApiKeyValue api_key = 2;
PermissionId permission_id = 3;
}

message CheckApiKeyPermissionResponse {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import "google/protobuf/wrappers.proto";
message Threshold {
google.protobuf.DoubleValue from = 1;
google.protobuf.StringValue color = 2;
google.protobuf.StringValue label = 3;
}

enum ThresholdType {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ message Gauge {
message Threshold {
google.protobuf.DoubleValue from = 1;
google.protobuf.StringValue color = 2;
google.protobuf.StringValue label = 3;
}

enum Aggregation {
Expand Down
24 changes: 12 additions & 12 deletions protofetch.lock
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,14 @@ commit_hash = "0d9733fd0052f743cdb14e62a6e4ae179676ea41"
[[dependencies]]
name = "cx-api-archive"
url = "github.com/coralogix/cx-api-archive"
revision = "v0.0.62"
commit_hash = "fc2c027ea0df265801aa52c89917df3e1ba71fc0"
revision = "v0.0.63"
commit_hash = "6c41a3b506946a877aa1fa9f04e832819abd0887"

[[dependencies]]
name = "cx-api-dashboards"
url = "github.com/coralogix/cx-api-dashboards"
revision = "v1.2.1"
commit_hash = "90fab2eed21e184ac693a16178a8b9b7ccb7bf52"
revision = "v1.2.2"
commit_hash = "605de7e4c962b1a366f7f50866caab0a0a048b0d"

[[dependencies]]
name = "cx-api-data-usage"
Expand All @@ -45,8 +45,8 @@ commit_hash = "28dc6f7ba38585d9641d014e8474eb0db47d30a2"
[[dependencies]]
name = "cx-api-dataprime"
url = "github.com/coralogix/cx-api-dataprime"
revision = "v0.303"
commit_hash = "5eac8841c47c271259863d4bcb359438f5d59ebc"
revision = "v0.307"
commit_hash = "ac67c50e3170e7c6554ef635daca024cf649510a"

[[dependencies]]
name = "cx-api-enrichment"
Expand All @@ -57,8 +57,8 @@ commit_hash = "19e36962f6fcced9bd167870b78c408ba4caafc6"
[[dependencies]]
name = "cx-api-extensions"
url = "github.com/coralogix/cx-api-extensions"
revision = "v1.0.0"
commit_hash = "0c93cdb178b9324c2e05c1260aba61f21d071428"
revision = "v1.0.1"
commit_hash = "f08ff60f5c8836062c171127c007de32cbeced7a"

[[dependencies]]
name = "cx-api-logs2metrics"
Expand Down Expand Up @@ -87,8 +87,8 @@ commit_hash = "64fc6023e1ec94c5096e749a6739cf1de07f645b"
[[dependencies]]
name = "cx-api-permissions"
url = "github.com/coralogix/cx-api-permissions"
revision = "v0.1.81"
commit_hash = "844cd2c89265a468dff8eeb5120c8f28a6b0b44c"
revision = "v0.1.82"
commit_hash = "455737602f4b1a059b97f750935f5f01e14ab6d4"

[[dependencies]]
name = "cx-api-quota"
Expand All @@ -105,8 +105,8 @@ commit_hash = "e1375b8f745ee1f85a328a93ed4f4af2e71fd053"
[[dependencies]]
name = "cx-api-service-catalog"
url = "github.com/coralogix/cx-api-service-catalog"
revision = "v0.3.99"
commit_hash = "b5d88ce3ba771b276ebac8d476ccc604255ad5e9"
revision = "v0.3.101"
commit_hash = "35931517a1427a405896acbf1deb6d02593ba08d"

[[dependencies]]
name = "cx-api-tags"
Expand Down
Loading

0 comments on commit bf7f499

Please sign in to comment.