fix: resolve comments

instill-ai · Nov 6, 2024 · 6af38dd · 6af38dd
1 parent a2a24c7
commit 6af38dd
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 10 deletions.
diff --git a/model/model/v1alpha/model.proto b/model/model/v1alpha/model.proto
@@ -1724,7 +1724,8 @@ message UndeployOrganizationModelAdminResponse {}
 message ModelRun {
   // Model Run UUID.
   string uid = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
-  // Reversed for `model_uid`
+  // 2 is reserved for the model UUID. Public resources should be identified by
+  // their ID and parent resource.
   reserved 2;
   // Model run status.
   common.run.v1alpha.RunStatus status = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
@@ -1740,7 +1741,8 @@ message ModelRun {
     (google.api.field_behavior) = OUTPUT_ONLY,
     (google.api.field_behavior) = OPTIONAL
   ];
-  // Runner ID. If current viewing requester does not have enough permission, it will return null.
+  // Runner ID. The user triggered the run. If current viewing requester does not
+  // have enough permission, it will return null.
   optional string runner_id = 7 [
     (google.api.field_behavior) = OUTPUT_ONLY,
     (google.api.field_behavior) = OPTIONAL
@@ -1770,10 +1772,10 @@ message ModelRun {
     (google.api.field_behavior) = OUTPUT_ONLY,
     (google.api.field_behavior) = OPTIONAL
   ];
-  // Requester ID. This field might be empty if the model run belongs to a
-  // deleted namespace.
+  // Requester ID. The namespace used to trigger the run. This field might be
+  // empty if the model run belongs to a deleted namespace.
   string requester_id = 16 [(google.api.field_behavior) = OUTPUT_ONLY];
-  // Model Namespace ID. The owner namespace id of the model.
+  // ID of the namespace that owns the model.
   string model_namespace_id = 21 [(google.api.field_behavior) = OUTPUT_ONLY];
 }
 

diff --git a/vdp/pipeline/v1beta/pipeline.proto b/vdp/pipeline/v1beta/pipeline.proto
@@ -1996,7 +1996,8 @@ message FileReference {
 
 // PipelineRun represents a single execution of a pipeline.
 message PipelineRun {
-  // Reversed for `pipeline_uid`
+  // 1 is reserved for the pipeline UUID. Public resources should be identified by
+  // their ID and parent resource.
   reserved 1;
 
   // Unique identifier for each run.
@@ -2017,7 +2018,8 @@ message PipelineRun {
     (google.api.field_behavior) = OPTIONAL
   ];
 
-  // Runner ID. If current viewing requester does not have enough permission, it will return null.
+  // Runner ID. The user triggered the run. If current viewing requester does not
+  // have enough permission, it will return null.
   optional string runner_id = 7 [
     (google.api.field_behavior) = OUTPUT_ONLY,
     (google.api.field_behavior) = OPTIONAL
@@ -2072,11 +2074,11 @@ message PipelineRun {
     (google.api.field_behavior) = OPTIONAL
   ];
 
-  // Requester ID. This field might be empty if the pipeline run belongs to a
-  // deleted namespace.
+  // Requester ID. The namespace used to trigger the run. This field might be
+  // empty if the pipeline run belongs to a deleted namespace.
   string requester_id = 20 [(google.api.field_behavior) = OUTPUT_ONLY];
 
-  // Pipeline Namespace ID. The owner namespace id of the pipeline.
+  // ID of the namespace that owns the pipeline.
   string pipeline_namespace_id = 21 [(google.api.field_behavior) = OUTPUT_ONLY];
 }