Add deprecated label for protos (#202)

Signed-off-by: Enwei Jiao <[email protected]>
milvus-io · Oct 26, 2023 · 2b0b91b · 2b0b91b
1 parent 0c43e82
commit 2b0b91b
Show file tree

Hide file tree

Showing 7 changed files with 813 additions and 793 deletions.
diff --git a/cmake/protobuf/CMakeLists.txt b/cmake/protobuf/CMakeLists.txt
@@ -1,11 +1,11 @@
 set( PROTOBUF_SOURCE_URL
-     "https://github.com/protocolbuffers/protobuf/releases/download/v3.9.0/protobuf-cpp-3.9.0.zip" )
+     "https://github.com/protocolbuffers/protobuf/archive/refs/tags/v3.21.4.zip" )
 
-message( STATUS "Building protobuf-cpp-3.9.0 from source" )
+message( STATUS "Building protobuf-cpp from source" )
 
 FetchContent_Declare( protobuf
     URL             ${PROTOBUF_SOURCE_URL}
-    URL_MD5         "9562b27cc6ac5ebd087f201f1310c885"
+    URL_MD5         "4f524caf15beb4354d64b63901587932"
     DOWNLOAD_DIR    ${CMAKE_CURRENT_BINARY_DIR}/../3rdparty_download
     SOURCE_DIR      ${CMAKE_CURRENT_BINARY_DIR}/protobuf-src
     BINARY_DIR      ${CMAKE_CURRENT_BINARY_DIR}/protobuf-build
@@ -22,4 +22,4 @@ if ( NOT protobuf_POPULATED )
     add_subdirectory( ${protobuf_SOURCE_DIR}/cmake
                       ${protobuf_BINARY_DIR}
                       EXCLUDE_FROM_ALL )
-endif()
+endif()
diff --git a/go-api/commonpb/common.pb.go b/go-api/commonpb/common.pb.go
diff --git a/go-api/milvuspb/milvus.pb.go b/go-api/milvuspb/milvus.pb.go
diff --git a/go-api/schemapb/schema.pb.go b/go-api/schemapb/schema.pb.go
diff --git a/proto/common.proto b/proto/common.proto
@@ -14,6 +14,7 @@ import "google/protobuf/descriptor.proto";
 
 // Deprecated
 enum ErrorCode {
+    option deprecated = true;
     Success = 0;
     UnexpectedError = 1;
     ConnectFailed = 2;
@@ -70,7 +71,7 @@ enum ErrorCode {
     DiskQuotaExhausted = 54;
     TimeTickLongDelay = 55;
     NotReadyServe = 56;
-    // Coord is switching from standby mode to active mode 
+    // Coord is switching from standby mode to active mode
     NotReadyCoordActivating = 57;
 
     // Service availability.
@@ -102,7 +103,7 @@ enum SegmentState {
 }
 
 message Status {
-    ErrorCode error_code = 1;
+    ErrorCode error_code = 1 [deprecated=true];
     string reason = 2;
     int32 code = 3;
 }
@@ -165,7 +166,7 @@ enum MsgType {
     RenameCollection = 112;
     DescribeAlias = 113;
     ListAliases = 114;
-    
+
     /* DEFINITION REQUESTS: PARTITION */
     CreatePartition = 200;
     DropPartition = 201;

diff --git a/proto/milvus.proto b/proto/milvus.proto
@@ -48,9 +48,13 @@ service MilvusService {
   rpc DescribeIndex(DescribeIndexRequest) returns (DescribeIndexResponse) {}
   rpc GetIndexStatistics(GetIndexStatisticsRequest) returns (GetIndexStatisticsResponse) {}
   // Deprecated: use DescribeIndex instead
-  rpc GetIndexState(GetIndexStateRequest) returns (GetIndexStateResponse) {}
+  rpc GetIndexState(GetIndexStateRequest) returns (GetIndexStateResponse) {
+      option deprecated = true;
+  }
   // Deprecated: use DescribeIndex instead
-  rpc GetIndexBuildProgress(GetIndexBuildProgressRequest) returns (GetIndexBuildProgressResponse) {}
+  rpc GetIndexBuildProgress(GetIndexBuildProgressRequest) returns (GetIndexBuildProgressResponse) {
+      option deprecated = true;
+  }
   rpc DropIndex(DropIndexRequest) returns (common.Status) {}
 
   rpc Insert(InsertRequest) returns (MutationResult) {}
@@ -419,6 +423,7 @@ message GetCollectionStatisticsResponse {
 */
 // Deprecated: use GetLoadingProgress rpc instead
 enum ShowType {
+  option deprecated = true;
   // Will return all collections
   All = 0;
   // Will return loaded collections with their inMemory_percentages
@@ -443,7 +448,7 @@ message ShowCollectionsRequest {
   ShowType type = 4;
   // When type is InMemory, will return these collection's inMemory_percentages.(Optional)
   // Deprecated: use GetLoadingProgress rpc instead
-  repeated string collection_names = 5;
+  repeated string collection_names = 5 [deprecated=true];
 }
 
 /*
@@ -462,7 +467,7 @@ message ShowCollectionsResponse {
   repeated uint64 created_utc_timestamps = 5;
   // Load percentage on querynode when type is InMemory
   // Deprecated: use GetLoadingProgress rpc instead
-  repeated int64 inMemory_percentages = 6;
+  repeated int64 inMemory_percentages = 6 [deprecated=true];
   // Indicate whether query service is available
   repeated bool query_service_available = 7;
 }
@@ -573,7 +578,7 @@ message ShowPartitionsRequest {
   repeated string partition_names = 5;
   // Decide return Loaded partitions or All partitions(Optional)
   // Deprecated: use GetLoadingProgress rpc instead
-  ShowType type = 6;
+  ShowType type = 6 [deprecated=true];
 }
 
 /*
@@ -593,7 +598,7 @@ message ShowPartitionsResponse {
   repeated uint64 created_utc_timestamps = 5;
   // Load percentage on querynode
   // Deprecated: use GetLoadingProgress rpc instead
-  repeated int64 inMemory_percentages = 6;
+  repeated int64 inMemory_percentages = 6 [deprecated=true];
 }
 
 message DescribeSegmentRequest {
@@ -969,7 +974,7 @@ message QuerySegmentInfo {
   string index_name = 6;
   int64 indexID = 7;
   // deprecated, check node_ids(NodeIds) field
-  int64 nodeID = 8;
+  int64 nodeID = 8 [deprecated=true];
   common.SegmentState state = 9;
   repeated int64 nodeIds = 10;
 }

diff --git a/proto/schema.proto b/proto/schema.proto
@@ -11,6 +11,7 @@ option java_generate_equals_and_hash = true;
 option csharp_namespace = "Milvus.Client.Grpc";
 
 import "common.proto";
+import "google/protobuf/descriptor.proto";
 
 /**
  * @brief Field data type
@@ -69,7 +70,7 @@ message FieldSchema {
 message CollectionSchema {
   string name = 1;
   string description = 2;
-  bool autoID = 3; // deprecated later, keep compatible with c++ part now
+  bool autoID = 3 [deprecated=true]; // deprecated later, keep compatible with c++ part now
   repeated FieldSchema fields = 4;
   bool enable_dynamic_field = 5; // mark whether this table has the dynamic field function enabled.
 }