Change OpenStorageSchedule API parameter type to string (#2454)

Signed-off-by: Tengxiao Wang <[email protected]>
libopenstorage · Jun 18, 2024 · e4b050e · e4b050e
1 parent 1829c49
commit e4b050e
Show file tree

Hide file tree

Showing 6 changed files with 3,957 additions and 3,997 deletions.
diff --git a/SDK_CHANGELOG.md b/SDK_CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## Releases
 
+### v0.186.0 - (06/17/2024)
+
+* Change OpenStorageSchedule API parameter type to string
+
 ### v0.185.0 - (05/24/2024)
 
 * Added a parameter for FlashArray Pod names

diff --git a/api/api.pb.go b/api/api.pb.go
diff --git a/api/api.pb.gw.go b/api/api.pb.gw.go
diff --git a/api/api.proto b/api/api.proto
@@ -4144,8 +4144,9 @@ message Schedule {
 message SdkInspectScheduleRequest {
   // ID of the schedule
   string id = 1;
-  // Type is schedule type
-  Job.Type type = 2;
+  // Type is schedule type (cast to string from a Job.Type enum, as the version of
+  // protoc-gen-grpc-gateway on release branch doesn't support enum type in REST API path parameter)
+  string type = 2;
 }
 
 // Defines a response of schedule information
@@ -4155,8 +4156,9 @@ message SdkInspectScheduleResponse {
 
 // Defines a request to enumerate all schedules of a type
 message SdkEnumerateSchedulesRequest {
-  // Type is schedule type
-  Job.Type type = 1;
+  // Type is schedule type (cast to string from a Job.Type enum, as the version of
+  // protoc-gen-grpc-gateway on release branch doesn't support enum type in REST API path parameter)
+  string type = 1;
 }
 
 // Defines a response containing list of schedules
@@ -4168,8 +4170,9 @@ message SdkEnumerateSchedulesResponse {
 message SdkDeleteScheduleRequest {
   // ID of the schedule
   string id = 1;
-  // Type is schedule type
-  Job.Type type = 2;
+  // Type is schedule type (cast to string from a Job.Type enum, as the version of
+  // protoc-gen-grpc-gateway on release branch doesn't support enum type in REST API path parameter)
+  string type = 2;
 }
 
 // Empty response
@@ -5854,7 +5857,7 @@ message SdkVersion {
     // SDK version major value of this specification
     Major = 0;
     // SDK version minor value of this specification
-    Minor = 185;
+    Minor = 186;
     // SDK version patch value of this specification
     Patch = 0;
   }

diff --git a/api/server/sdk/api/api.swagger.json b/api/server/sdk/api/api.swagger.json
diff --git a/api/server/sdk/schedule_test.go b/api/server/sdk/schedule_test.go
@@ -47,7 +47,7 @@ func TestInspectSchedule(t *testing.T) {
 	r, err := c.Inspect(
 		context.Background(), 
 		&api.SdkInspectScheduleRequest{
-			Type: api.Job_DEFRAG, 
+			Type: "DEFRAG", 
 			Id: "12345",
 		},
 	)
@@ -100,7 +100,7 @@ func TestEnumerateSchedules(t *testing.T) {
 	r, err := c.Enumerate(
 		context.Background(), 
 		&api.SdkEnumerateSchedulesRequest{
-			Type: api.Job_DEFRAG,
+			Type: "DEFRAG",
 		},
 	)
 
@@ -132,7 +132,7 @@ func TestDeleteSchedule(t *testing.T) {
 		context.Background(),
 		&api.SdkDeleteScheduleRequest{
 			Id: "12345",
-			Type: api.Job_DEFRAG,
+			Type: "DEFRAG",
 		},
 	)
 	assert.NoError(t, err)