Separating Workflow Metadata and Defaults (#43)

* Separating Workflow Metadata and Defaults * make generate Co-authored-by: Miguel Toledo <[email protected]> Signed-off-by: Eduardo Apolinario <[email protected]>
flyteorg · Sep 13, 2023 · 097a422 · 097a422
1 parent 288f9a5
commit 097a422
Show file tree

Hide file tree

Showing 26 changed files with 2,065 additions and 334 deletions.
diff --git a/flyteidl/gen/pb-cpp/flyteidl/admin/workflow.pb.cc b/flyteidl/gen/pb-cpp/flyteidl/admin/workflow.pb.cc
diff --git a/flyteidl/gen/pb-cpp/flyteidl/core/compiler.pb.cc b/flyteidl/gen/pb-cpp/flyteidl/core/compiler.pb.cc
diff --git a/flyteidl/gen/pb-cpp/flyteidl/core/dynamic_job.pb.cc b/flyteidl/gen/pb-cpp/flyteidl/core/dynamic_job.pb.cc
diff --git a/flyteidl/gen/pb-cpp/flyteidl/core/workflow.pb.cc b/flyteidl/gen/pb-cpp/flyteidl/core/workflow.pb.cc
diff --git a/flyteidl/gen/pb-cpp/flyteidl/core/workflow.pb.h b/flyteidl/gen/pb-cpp/flyteidl/core/workflow.pb.h
diff --git a/flyteidl/gen/pb-cpp/flyteidl/core/workflow_closure.pb.cc b/flyteidl/gen/pb-cpp/flyteidl/core/workflow_closure.pb.cc
diff --git a/flyteidl/gen/pb-go/flyteidl/core/workflow.pb.go b/flyteidl/gen/pb-go/flyteidl/core/workflow.pb.go
diff --git a/flyteidl/gen/pb-go/flyteidl/core/workflow.pb.validate.go b/flyteidl/gen/pb-go/flyteidl/core/workflow.pb.validate.go
diff --git a/flyteidl/gen/pb-go/flyteidl/service/admin.swagger.json b/flyteidl/gen/pb-go/flyteidl/service/admin.swagger.json
@@ -5094,6 +5094,10 @@
       ],
       "default": "UNDEFINED"
     },
+    "coreWorkflowMetadata": {
+      "type": "object",
+      "description": "Metadata for the entire workflow.\nTo be used in the future."
+    },
     "coreWorkflowMetadataDefaults": {
       "type": "object",
       "properties": {
@@ -5126,8 +5130,8 @@
           "$ref": "#/definitions/coreIdentifier",
           "description": "A globally unique identifier for the workflow."
         },
-        "metadata_defaults": {
-          "$ref": "#/definitions/coreWorkflowMetadataDefaults",
+        "metadata": {
+          "$ref": "#/definitions/coreWorkflowMetadata",
           "description": "Extra metadata about the workflow."
         },
         "interface": {
@@ -5151,6 +5155,10 @@
         "failure_node": {
           "$ref": "#/definitions/coreNode",
           "description": "+optional A catch-all node. This node is executed whenever the execution engine determines the workflow has failed.\nThe interface of this node must match the Workflow interface with an additional input named \"error\" of type\npb.lyft.flyte.core.Error."
+        },
+        "metadata_defaults": {
+          "$ref": "#/definitions/coreWorkflowMetadataDefaults",
+          "title": "workflow defaults"
         }
       },
       "description": "Flyte Workflow Structure that encapsulates task, branch and subworkflow nodes to form a statically analyzable,\ndirected acyclic graph."

diff --git a/flyteidl/gen/pb-go/flyteidl/service/flyteadmin/README.md b/flyteidl/gen/pb-go/flyteidl/service/flyteadmin/README.md
@@ -226,6 +226,7 @@ Class | Method | HTTP request | Description
  - [CoreVoid](docs/CoreVoid.md)
  - [CoreWorkflowExecutionIdentifier](docs/CoreWorkflowExecutionIdentifier.md)
  - [CoreWorkflowExecutionPhase](docs/CoreWorkflowExecutionPhase.md)
+ - [CoreWorkflowMetadata](docs/CoreWorkflowMetadata.md)
  - [CoreWorkflowMetadataDefaults](docs/CoreWorkflowMetadataDefaults.md)
  - [CoreWorkflowNode](docs/CoreWorkflowNode.md)
  - [CoreWorkflowTemplate](docs/CoreWorkflowTemplate.md)

diff --git a/flyteidl/gen/pb-go/flyteidl/service/flyteadmin/api/swagger.yaml b/flyteidl/gen/pb-go/flyteidl/service/flyteadmin/api/swagger.yaml
@@ -6034,6 +6034,7 @@ definitions:
                     - null
                   map:
                     bindings: {}
+              metadata: {}
               failure_node:
                 branch_node:
                   if_else:
@@ -6854,6 +6855,7 @@ definitions:
                     - null
                   map:
                     bindings: {}
+              metadata: {}
               failure_node:
                 branch_node:
                   if_else:
@@ -7906,6 +7908,7 @@ definitions:
                     - null
                   map:
                     bindings: {}
+              metadata: {}
               failure_node:
                 branch_node:
                   if_else:
@@ -8839,6 +8842,7 @@ definitions:
                   - null
                 map:
                   bindings: {}
+            metadata: {}
             failure_node:
               branch_node:
                 if_else:
@@ -9659,6 +9663,7 @@ definitions:
                   - null
                 map:
                   bindings: {}
+            metadata: {}
             failure_node:
               branch_node:
                 if_else:
@@ -10711,6 +10716,7 @@ definitions:
                   - null
                 map:
                   bindings: {}
+            metadata: {}
             failure_node:
               branch_node:
                 if_else:
@@ -11600,6 +11606,7 @@ definitions:
                       - null
                     map:
                       bindings: {}
+                metadata: {}
                 failure_node:
                   branch_node:
                     if_else:
@@ -12420,6 +12427,7 @@ definitions:
                       - null
                     map:
                       bindings: {}
+                metadata: {}
                 failure_node:
                   branch_node:
                     if_else:
@@ -13472,6 +13480,7 @@ definitions:
                       - null
                     map:
                       bindings: {}
+                metadata: {}
                 failure_node:
                   branch_node:
                     if_else:
@@ -14302,6 +14311,7 @@ definitions:
                       - null
                     map:
                       bindings: {}
+                metadata: {}
                 failure_node:
                   branch_node:
                     if_else:
@@ -15122,6 +15132,7 @@ definitions:
                       - null
                     map:
                       bindings: {}
+                metadata: {}
                 failure_node:
                   branch_node:
                     if_else:
@@ -16174,6 +16185,7 @@ definitions:
                       - null
                     map:
                       bindings: {}
+                metadata: {}
                 failure_node:
                   branch_node:
                     if_else:
@@ -17522,6 +17534,7 @@ definitions:
               - null
             map:
               bindings: {}
+        metadata: {}
         failure_node:
           branch_node:
             if_else:
@@ -18369,6 +18382,7 @@ definitions:
                 - null
               map:
                 bindings: {}
+          metadata: {}
           failure_node:
             branch_node:
               if_else:
@@ -19189,6 +19203,7 @@ definitions:
                 - null
               map:
                 bindings: {}
+          metadata: {}
           failure_node:
             branch_node:
               if_else:
@@ -20241,6 +20256,7 @@ definitions:
                 - null
               map:
                 bindings: {}
+          metadata: {}
           failure_node:
             branch_node:
               if_else:
@@ -22530,6 +22546,9 @@ definitions:
     - "ABORTED"
     - "TIMED_OUT"
     default: "UNDEFINED"
+  coreWorkflowMetadata:
+    type: "object"
+    description: "Metadata for the entire workflow.\nTo be used in the future."
   coreWorkflowMetadataDefaults:
     type: "object"
     properties:
@@ -22572,9 +22591,9 @@ definitions:
       id:
         description: "A globally unique identifier for the workflow."
         $ref: "#/definitions/coreIdentifier"
-      metadata_defaults:
+      metadata:
         description: "Extra metadata about the workflow."
-        $ref: "#/definitions/coreWorkflowMetadataDefaults"
+        $ref: "#/definitions/coreWorkflowMetadata"
       interface:
         description: "Defines a strongly typed interface for the Workflow. This can\
           \ include some optional parameters."
@@ -22604,6 +22623,9 @@ definitions:
           \ this node must match the Workflow interface with an additional input named\
           \ \"error\" of type\npb.lyft.flyte.core.Error."
         $ref: "#/definitions/coreNode"
+      metadata_defaults:
+        title: "workflow defaults"
+        $ref: "#/definitions/coreWorkflowMetadataDefaults"
     description: "Flyte Workflow Structure that encapsulates task, branch and subworkflow\
       \ nodes to form a statically analyzable,\ndirected acyclic graph."
     example:
@@ -22710,6 +22732,7 @@ definitions:
             - null
           map:
             bindings: {}
+      metadata: {}
       failure_node:
         branch_node:
           if_else:

diff --git a/flyteidl/gen/pb-go/flyteidl/service/flyteadmin/model_core_workflow_metadata.go b/flyteidl/gen/pb-go/flyteidl/service/flyteadmin/model_core_workflow_metadata.go
@@ -0,0 +1,14 @@
+/*
+ * flyteidl/service/admin.proto
+ *
+ * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+ *
+ * API version: version not set
+ * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
+ */
+
+package flyteadmin
+
+// Metadata for the entire workflow. To be used in the future.
+type CoreWorkflowMetadata struct {
+}
diff --git a/flyteidl/gen/pb-go/flyteidl/service/flyteadmin/model_core_workflow_template.go b/flyteidl/gen/pb-go/flyteidl/service/flyteadmin/model_core_workflow_template.go
@@ -14,7 +14,7 @@ type CoreWorkflowTemplate struct {
 	// A globally unique identifier for the workflow.
 	Id *CoreIdentifier `json:"id,omitempty"`
 	// Extra metadata about the workflow.
-	MetadataDefaults *CoreWorkflowMetadataDefaults `json:"metadata_defaults,omitempty"`
+	Metadata *CoreWorkflowMetadata `json:"metadata,omitempty"`
 	// Defines a strongly typed interface for the Workflow. This can include some optional parameters.
 	Interface_ *CoreTypedInterface `json:"interface,omitempty"`
 	// A list of nodes. In addition, \"globals\" is a special reserved node id that can be used to consume workflow inputs.
@@ -23,4 +23,5 @@ type CoreWorkflowTemplate struct {
 	Outputs []CoreBinding `json:"outputs,omitempty"`
 	// +optional A catch-all node. This node is executed whenever the execution engine determines the workflow has failed. The interface of this node must match the Workflow interface with an additional input named \"error\" of type pb.lyft.flyte.core.Error.
 	FailureNode *CoreNode `json:"failure_node,omitempty"`
+	MetadataDefaults *CoreWorkflowMetadataDefaults `json:"metadata_defaults,omitempty"`
 }
diff --git a/flyteidl/gen/pb-go/flyteidl/service/openapi.go b/flyteidl/gen/pb-go/flyteidl/service/openapi.go