From 0c545b5f345bc0a7d2134e9b089c94e0d29428b4 Mon Sep 17 00:00:00 2001
From: "Chang, Hui-Tang" <huitang.chang@instill.tech>
Date: Tue, 10 Oct 2023 10:55:20 +0800
Subject: [PATCH] chore(pipeline): add `metadata` field in pipeline payload

---
 openapiv2/openapiv2.swagger.yaml    | 12 ++++++++++++
 vdp/pipeline/v1alpha/pipeline.proto |  4 ++++
 2 files changed, 16 insertions(+)

diff --git a/openapiv2/openapiv2.swagger.yaml b/openapiv2/openapiv2.swagger.yaml
index cd7dc986..f37a23db 100644
--- a/openapiv2/openapiv2.swagger.yaml
+++ b/openapiv2/openapiv2.swagger.yaml
@@ -2119,6 +2119,9 @@ paths:
               permission:
                 $ref: '#/definitions/v1alphaPermission'
                 title: Pipeline permission
+              metadata:
+                type: object
+                title: 'Metadata: store Console-related data such as pipeline builder layout'
             title: A pipeline resource to update
       tags:
         - PipelinePublicService
@@ -2254,6 +2257,9 @@ paths:
                 type: string
                 title: Alias
                 readOnly: true
+              metadata:
+                type: object
+                title: 'Metadata: store Console-related data such as pipeline builder layout'
             title: A pipeline release resource to update
       tags:
         - PipelinePublicService
@@ -7315,6 +7321,9 @@ definitions:
       permission:
         $ref: '#/definitions/v1alphaPermission'
         title: Pipeline permission
+      metadata:
+        type: object
+        title: 'Metadata: store Console-related data such as pipeline builder layout'
     title: Pipeline represents the content of a pipeline
   v1alphaPipelineData:
     type: object
@@ -7379,6 +7388,9 @@ definitions:
         type: string
         title: Alias
         readOnly: true
+      metadata:
+        type: object
+        title: 'Metadata: store Console-related data such as pipeline builder layout'
     title: PipelineRelease represents the content of a pipeline release
   v1alphaPipelineTriggerChartRecord:
     type: object
diff --git a/vdp/pipeline/v1alpha/pipeline.proto b/vdp/pipeline/v1alpha/pipeline.proto
index 6cb4ca46..5402a41f 100644
--- a/vdp/pipeline/v1alpha/pipeline.proto
+++ b/vdp/pipeline/v1alpha/pipeline.proto
@@ -146,6 +146,8 @@ message Pipeline {
   google.protobuf.Timestamp delete_time = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
   // Pipeline permission
   Permission permission = 15;
+  // Metadata: store Console-related data such as pipeline builder layout
+  google.protobuf.Struct metadata = 16;
 }
 
 // The metadata
@@ -196,6 +198,8 @@ message PipelineRelease {
   google.protobuf.Timestamp delete_time = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
   // Alias
   string alias = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+  // Metadata: store Console-related data such as pipeline builder layout
+  google.protobuf.Struct metadata = 12;
 }
 
 // ListPipelinesRequest represents a request to list pipelines