docs: conditional forwarding from source is allowed (#1823)

Signed-off-by: Keran Yang <[email protected]>
numaproj · Jul 12, 2024 · 54a5f77 · 54a5f77
1 parent 41e7878
commit 54a5f77
Show file tree

Hide file tree

Showing 7 changed files with 13 additions and 10 deletions.
diff --git a/api/json-schema/schema.json b/api/json-schema/schema.json
@@ -17812,7 +17812,7 @@
       "properties": {
         "conditions": {
           "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.ForwardConditions",
-          "description": "Conditional forwarding, only allowed when \"From\" is a Sink or UDF."
+          "description": "Conditional forwarding, only allowed when \"From\" is a Source or UDF."
         },
         "from": {
           "type": "string"
@@ -18016,7 +18016,7 @@
       "properties": {
         "conditions": {
           "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.ForwardConditions",
-          "description": "Conditional forwarding, only allowed when \"From\" is a Sink or UDF."
+          "description": "Conditional forwarding, only allowed when \"From\" is a Source or UDF."
         },
         "from": {
           "type": "string"

diff --git a/api/openapi-spec/swagger.json b/api/openapi-spec/swagger.json
@@ -17822,7 +17822,7 @@
       ],
       "properties": {
         "conditions": {
-          "description": "Conditional forwarding, only allowed when \"From\" is a Sink or UDF.",
+          "description": "Conditional forwarding, only allowed when \"From\" is a Source or UDF.",
           "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.ForwardConditions"
         },
         "from": {
@@ -18024,7 +18024,7 @@
       ],
       "properties": {
         "conditions": {
-          "description": "Conditional forwarding, only allowed when \"From\" is a Sink or UDF.",
+          "description": "Conditional forwarding, only allowed when \"From\" is a Source or UDF.",
           "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.ForwardConditions"
         },
         "from": {

diff --git a/docs/APIs.md b/docs/APIs.md
@@ -1794,7 +1794,7 @@ ForwardConditions </a> </em>
 <em>(Optional)</em>
 <p>
 
-Conditional forwarding, only allowed when “From” is a Sink or UDF.
+Conditional forwarding, only allowed when “From” is a Source or UDF.
 </p>
 
 </td>

diff --git a/pkg/apis/numaflow/v1alpha1/edge_types.go b/pkg/apis/numaflow/v1alpha1/edge_types.go
@@ -21,7 +21,7 @@ import "fmt"
 type Edge struct {
 	From string `json:"from" protobuf:"bytes,1,opt,name=from"`
 	To   string `json:"to" protobuf:"bytes,2,opt,name=to"`
-	// Conditional forwarding, only allowed when "From" is a Sink or UDF.
+	// Conditional forwarding, only allowed when "From" is a Source or UDF.
 	// +optional
 	Conditions *ForwardConditions `json:"conditions" protobuf:"bytes,3,opt,name=conditions"`
 	// OnFull specifies the behaviour for the write actions when the inter step buffer is full.

diff --git a/pkg/apis/numaflow/v1alpha1/generated.proto b/pkg/apis/numaflow/v1alpha1/generated.proto
diff --git a/pkg/apis/numaflow/v1alpha1/openapi_generated.go b/pkg/apis/numaflow/v1alpha1/openapi_generated.go
diff --git a/pkg/reconciler/pipeline/validate_test.go b/pkg/reconciler/pipeline/validate_test.go
@@ -511,9 +511,12 @@ func TestValidatePipeline(t *testing.T) {
 		assert.NoError(t, err)
 	})
 
-	t.Run("allow conditional forwarding from source vertex", func(t *testing.T) {
+	t.Run("allow conditional forwarding from source vertex or udf vertex", func(t *testing.T) {
 		testObj := testPipeline.DeepCopy()
 		operatorOr := dfv1.LogicOperatorOr
+		testObj.Spec.Edges[0].Conditions = &dfv1.ForwardConditions{Tags: &dfv1.TagConditions{
+			Operator: &operatorOr,
+			Values:   []string{"hello"}}}
 		testObj.Spec.Edges[1].Conditions = &dfv1.ForwardConditions{Tags: &dfv1.TagConditions{
 			Operator: &operatorOr,
 			Values:   []string{"hello"}}}
-Original file line number
+Diff line change
@@ Expand Up / @@ -1794,7 +1794,7 @@ ForwardConditions </a> </em> @@
     <em>(Optional)</em>
     <p>
-    Conditional forwarding, only allowed when “From” is a Sink or UDF.
+    Conditional forwarding, only allowed when “From” is a Source or UDF.
     </p>
     </td>
@@ Expand Down @@