Skip to content

Commit f9a2912

Browse files
authored
feat(compass): change tag template identifier to assetid (#131)
1 parent efc71a5 commit f9a2912

File tree

1 file changed

+54
-60
lines changed

1 file changed

+54
-60
lines changed

odpf/compass/v1beta1/service.proto

Lines changed: 54 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -409,64 +409,64 @@ service CompassService {
409409
}
410410

411411
// Domain: Tag Templates
412-
rpc CreateTag(CreateTagRequest) returns (CreateTagResponse) {
412+
rpc CreateTagAsset(CreateTagAssetRequest) returns (CreateTagAssetResponse) {
413413
option (google.api.http) = {
414-
post: "/v1beta1/tags"
414+
post: "/v1beta1/tags/assets"
415415
body: "*"
416416
};
417417

418418
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
419-
summary: "Tag a record";
420-
description: "Tag a record in a type with a tag template";
419+
summary: "Tag an asset";
420+
description: "Tag an asset with a tag template";
421421
tags: ["Tag"];
422422
};
423423
}
424424

425-
rpc GetTagsByRecordAndTemplate(GetTagsByRecordAndTemplateRequest) returns (GetTagsByRecordAndTemplateResponse) {
425+
rpc GetTagsByAssetAndTemplate(GetTagsByAssetAndTemplateRequest) returns (GetTagsByAssetAndTemplateResponse) {
426426
option (google.api.http) = {
427-
get: "/v1beta1/tags/types/{type}/records/{record_urn}/templates/{template_urn}"
427+
get: "/v1beta1/tags/assets/{asset_id}/templates/{template_urn}"
428428
};
429429

430430
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
431-
summary: "Find a tag by record and template";
432-
description: "Find a single tag using record urn and template urn";
431+
summary: "Find a tag by asset and template";
432+
description: "Find a single tag using asset id and template urn";
433433
tags: ["Tag"];
434434
};
435435
}
436436

437-
rpc UpdateTag(UpdateTagRequest) returns (UpdateTagResponse) {
437+
rpc UpdateTagAsset(UpdateTagAssetRequest) returns (UpdateTagAssetResponse) {
438438
option (google.api.http) = {
439-
put: "/v1beta1/tags/types/{type}/records/{record_urn}/templates/{template_urn}"
439+
put: "/v1beta1/tags/assets/{asset_id}/templates/{template_urn}"
440440
body: "*"
441441
};
442442

443443
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
444-
summary: "Update a tag on a record";
445-
description: "Update a tag on a record in a type";
444+
summary: "Update a tag on an asset";
445+
description: "Update a tag on an asset";
446446
tags: ["Tag"];
447447
};
448448
}
449449

450-
rpc DeleteTag(DeleteTagRequest) returns (DeleteTagResponse) {
450+
rpc DeleteTagAsset(DeleteTagAssetRequest) returns (DeleteTagAssetResponse) {
451451
option (google.api.http) = {
452-
delete: "/v1beta1/tags/types/{type}/records/{record_urn}/templates/{template_urn}"
452+
delete: "/v1beta1/tags/assets/{asset_id}/templates/{template_urn}"
453453
};
454454

455455
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
456-
summary: "Remove a tag on a record";
457-
description: "Remove a tag on a record in a type";
456+
summary: "Remove a tag on an asset";
457+
description: "Remove a tag on an asset in a type";
458458
tags: ["Tag"];
459459
};
460460
}
461461

462-
rpc GetTagsByRecord(GetTagsByRecordRequest) returns (GetTagsByRecordResponse) {
462+
rpc GetAllTagsByAsset(GetAllTagsByAssetRequest) returns (GetAllTagsByAssetResponse) {
463463
option (google.api.http) = {
464-
get: "/v1beta1/tags/types/{type}/records/{record_urn}"
464+
get: "/v1beta1/tags/assets/{asset_id}"
465465
};
466466

467467
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
468-
summary: "Get a record's tags";
469-
description: "Get all tags for a record in a type";
468+
summary: "Get an asset's tags";
469+
description: "Get all tags for an assets";
470470
tags: ["Tag"];
471471
};
472472
}
@@ -836,72 +836,67 @@ message GetMyDiscussionsResponse {
836836
repeated Discussion data = 1;
837837
}
838838

839-
message CreateTagRequest {
839+
message CreateTagAssetRequest {
840840
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = {
841841
json_schema: {
842-
title: "CreateTagRequest"
842+
title: "CreateTagAssetRequest"
843843
description: "Request to be sent to create a tag"
844-
required: ["record_urn", "template_urn", "tag_values"]
844+
required: ["asset_id", "template_urn", "tag_values"]
845845
}
846846
};
847847

848-
string record_type = 1;
849-
string record_urn = 2; // required
850-
string template_urn = 3; // required
851-
repeated TagValue tag_values = 4; // required
852-
string template_display_name = 5;
853-
string template_description = 6;
848+
string asset_id = 1; // required
849+
string template_urn = 2; // required
850+
repeated TagValue tag_values = 3; // required
851+
string template_display_name = 4;
852+
string template_description = 5;
854853
}
855854

856-
message CreateTagResponse {
855+
message CreateTagAssetResponse {
857856
Tag data = 1;
858857
}
859858

860-
message GetTagsByRecordAndTemplateRequest {
861-
string type = 1;
862-
string record_urn = 2;
859+
message GetTagsByAssetAndTemplateRequest {
860+
string asset_id = 1;
863861
string template_urn = 3;
864862
}
865863

866-
message GetTagsByRecordAndTemplateResponse {
864+
message GetTagsByAssetAndTemplateResponse {
867865
Tag data = 1;
868866
}
869867

870-
message UpdateTagRequest {
868+
message UpdateTagAssetRequest {
871869
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = {
872870
json_schema: {
873-
title: "UpdateTagRequest"
874-
description: "Request to be sent to update a tag"
875-
required: ["tag_values"]
871+
title: "UpdateTagAssetRequest"
872+
description: "Request to be sent to update an asset tag"
873+
required: ["asset_id","tag_values"]
876874
}
877875
};
878876

879-
string type = 1;
880-
string record_urn = 2;
881-
string template_urn = 3;
882-
repeated TagValue tag_values = 4; // required
883-
string template_display_name = 5;
884-
string template_description = 6;
877+
string asset_id = 1; // required
878+
string template_urn = 2;
879+
repeated TagValue tag_values = 3; // required
880+
string template_display_name = 4;
881+
string template_description = 5;
885882
}
886883

887-
message UpdateTagResponse {
884+
message UpdateTagAssetResponse {
888885
Tag data = 1;
889886
}
890887

891-
message DeleteTagRequest {
892-
string type = 1;
893-
string record_urn = 2;
894-
string template_urn = 3;
888+
message DeleteTagAssetRequest {
889+
string asset_id = 1;
890+
string template_urn = 2;
895891
}
896892

897-
message DeleteTagResponse {}
893+
message DeleteTagAssetResponse {}
898894

899-
message GetTagsByRecordRequest {
900-
string type = 1;
901-
string record_urn = 2;
895+
message GetAllTagsByAssetRequest {
896+
string asset_id = 1;
902897
}
903898

904-
message GetTagsByRecordResponse {
899+
message GetAllTagsByAssetResponse {
905900
repeated Tag data = 1;
906901
}
907902

@@ -1086,12 +1081,11 @@ message Tag {
10861081
}
10871082
};
10881083

1089-
string record_type = 1;
1090-
string record_urn = 2;
1091-
string template_urn = 3;
1092-
repeated TagValue tag_values = 4;
1093-
string template_display_name = 5;
1094-
string template_description = 6;
1084+
string asset_id = 1;
1085+
string template_urn = 2;
1086+
repeated TagValue tag_values = 3;
1087+
string template_display_name = 4;
1088+
string template_description = 5;
10951089
}
10961090

10971091
message TagValue {

0 commit comments

Comments
 (0)