chore: add comments for stream rpc

instill-ai · May 16, 2022 · e6df797 · e6df797
1 parent 77b02ea
commit e6df797
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 7 deletions.
diff --git a/instill/model/v1alpha/model_service.proto b/instill/model/v1alpha/model_service.proto
@@ -121,8 +121,12 @@ service ModelService {
   // CreateModelBinaryFileUpload method receives a
   // CreateModelBinaryFileUploadRequest message and returns a
   // CreateModelBinaryFileUploadResponse message.
+  //
+  // Endpoint: "POST /v1alpha/models:multipart"
   rpc CreateModelBinaryFileUpload(stream CreateModelBinaryFileUploadRequest)
-      returns (CreateModelBinaryFileUploadResponse) {}
+      returns (CreateModelBinaryFileUploadResponse) {
+    option (google.api.method_signature) = "id,model_definition,content";
+  }
 
   // GetModel method receives a GetModelRequest message and returns a
   // GetModelResponse
@@ -180,8 +184,8 @@ service ModelService {
     option (google.api.method_signature) = "name";
   }
 
-  // UnpublishModel method receives a UnpublishModelRequest message and returns a
-  // UnpublishModelResponse
+  // UnpublishModel method receives a UnpublishModelRequest message and returns
+  // a UnpublishModelResponse
   rpc UnpublishModel(UnpublishModelRequest) returns (UnpublishModelResponse) {
     option (google.api.http) = {
       post : "/v1alpha/{name=models/*}:unpublish"
@@ -269,7 +273,11 @@ service ModelService {
   // TriggerModelInstanceBinaryFileUpload method receives a
   // TriggerModelInstanceBinaryFileUploadRequest message and returns a
   // TriggerModelInstanceBinaryFileUploadResponse message.
+  //
+  // Endpoint: "POST/v1alpha/{name=models/*/instances/*}:trigger-multipart"
   rpc TriggerModelInstanceBinaryFileUpload(
       stream TriggerModelInstanceBinaryFileUploadRequest)
-      returns (TriggerModelInstanceBinaryFileUploadResponse) {}
+      returns (TriggerModelInstanceBinaryFileUploadResponse) {
+    option (google.api.method_signature) = "name,file";
+  }
 }
diff --git a/instill/pipeline/v1alpha/pipeline_service.proto b/instill/pipeline/v1alpha/pipeline_service.proto
@@ -184,7 +184,11 @@ service PipelineService {
   // TriggerPipelineBinaryFileUpload method receives a
   // TriggerPipelineBinaryFileUploadRequest message and returns a
   // TriggerPipelineBinaryFileUploadResponse message.
+  //
+  // Endpoint: "POST /v1alpha/{name=pipelines/*}:trigger-multipart"
   rpc TriggerPipelineBinaryFileUpload(
       stream TriggerPipelineBinaryFileUploadRequest)
-      returns (TriggerPipelineBinaryFileUploadResponse) {}
+      returns (TriggerPipelineBinaryFileUploadResponse) {
+    option (google.api.method_signature) = "name,file";
+  }
 }
diff --git a/openapiv2/openapiv2.swagger.yaml b/openapiv2/openapiv2.swagger.yaml
@@ -916,8 +916,8 @@ paths:
   /v1alpha/{name}:unpublish:
     post:
       summary: |-
-        UnpublishModel method receives a UnpublishModelRequest message and returns a
-        UnpublishModelResponse
+        UnpublishModel method receives a UnpublishModelRequest message and returns
+        a UnpublishModelResponse
       operationId: ModelService_UnpublishModel
       responses:
         "200":