fix: typo, use timeout instead of ttl (#2494)

vigith · web-flow · commit 70993d56825c · 2025-03-21T18:59:07.000-07:00
Signed-off-by: Vigith Maurice &lt;vigith@gmail.com&gt;
diff --git a/api/json-schema/schema.json b/api/json-schema/schema.json
@@ -19641,7 +19641,7 @@
     "io.numaproj.numaflow.v1alpha1.AccumulatorWindow": {
       "description": "AccumulatorWindow describes a special kind of SessionWindow (similar to Global Window) where output should always have monotonically increasing WM but it can be manipulated through event-time by reordering the messages. NOTE: Quite powerful, should not be abused; it can cause stalling of pipelines and leaks.",
       "properties": {
-        "ttl": {
+        "timeout": {
           "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Duration",
           "description": "Timeout is the duration of inactivity after which the state of the accumulator is removed."
         }
diff --git a/api/openapi-spec/swagger.json b/api/openapi-spec/swagger.json
@@ -19646,7 +19646,7 @@
       "description": "AccumulatorWindow describes a special kind of SessionWindow (similar to Global Window) where output should always have monotonically increasing WM but it can be manipulated through event-time by reordering the messages. NOTE: Quite powerful, should not be abused; it can cause stalling of pipelines and leaks.",
       "type": "object",
       "properties": {
-        "ttl": {
+        "timeout": {
           "description": "Timeout is the duration of inactivity after which the state of the accumulator is removed.",
           "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Duration"
         }
diff --git a/config/base/crds/full/numaflow.numaproj.io_pipelines.yaml b/config/base/crds/full/numaflow.numaproj.io_pipelines.yaml
@@ -11129,7 +11129,7 @@ spec:
                               properties:
                                 accumulator:
                                   properties:
-                                    ttl:
+                                    timeout:
                                       type: string
                                   type: object
                                 fixed:
diff --git a/config/base/crds/full/numaflow.numaproj.io_vertices.yaml b/config/base/crds/full/numaflow.numaproj.io_vertices.yaml
@@ -5702,7 +5702,7 @@ spec:
                         properties:
                           accumulator:
                             properties:
-                              ttl:
+                              timeout:
                                 type: string
                             type: object
                           fixed:
diff --git a/config/install.yaml b/config/install.yaml
@@ -21000,7 +21000,7 @@ spec:
                               properties:
                                 accumulator:
                                   properties:
-                                    ttl:
+                                    timeout:
                                       type: string
                                   type: object
                                 fixed:
@@ -27640,7 +27640,7 @@ spec:
                         properties:
                           accumulator:
                             properties:
-                              ttl:
+                              timeout:
                                 type: string
                             type: object
                           fixed:
diff --git a/config/namespace-install.yaml b/config/namespace-install.yaml
@@ -21000,7 +21000,7 @@ spec:
                               properties:
                                 accumulator:
                                   properties:
-                                    ttl:
+                                    timeout:
                                       type: string
                                   type: object
                                 fixed:
@@ -27640,7 +27640,7 @@ spec:
                         properties:
                           accumulator:
                             properties:
-                              ttl:
+                              timeout:
                                 type: string
                             type: object
                           fixed:
diff --git a/docs/APIs.md b/docs/APIs.md
@@ -934,7 +934,7 @@ Description
 
 <td>
 
-<code>ttl</code></br> <em>
+<code>timeout</code></br> <em>
 <a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration">
 Kubernetes meta/v1.Duration </a> </em>
 </td>
diff --git a/examples/13-accumulator-window.yaml b/examples/13-accumulator-window.yaml
@@ -18,11 +18,6 @@ spec:
         max: 1
       source:
         http: {}
-#    - name: in
-#      source:
-#        generator:
-#          rpu: 5
-#          keyCount: 1
     - name: accum
       udf:
         container:
@@ -32,7 +27,7 @@ spec:
         groupBy:
           window:
             accumulator:
-              ttl: 10s
+              timeout: 10s
           keyed: true
           storage:
             persistentVolumeClaim:
diff --git a/pkg/apis/numaflow/v1alpha1/udf.go b/pkg/apis/numaflow/v1alpha1/udf.go
@@ -190,7 +190,7 @@ type SessionWindow struct {
 // NOTE: Quite powerful, should not be abused; it can cause stalling of pipelines and leaks.
 type AccumulatorWindow struct {
 	// Timeout is the duration of inactivity after which the state of the accumulator is removed.
-	Timeout *metav1.Duration `json:"ttl,omitempty" protobuf:"bytes,1,opt,name=timeout"`
+	Timeout *metav1.Duration `json:"timeout,omitempty" protobuf:"bytes,1,opt,name=timeout"`
 }
 
 // PBQStorage defines the persistence configuration for a vertex.
diff --git a/pkg/apis/numaflow/v1alpha1/zz_generated.openapi.go b/pkg/apis/numaflow/v1alpha1/zz_generated.openapi.go
diff --git a/rust/numaflow-models/src/models/accumulator_window.rs b/rust/numaflow-models/src/models/accumulator_window.rs
@@ -20,13 +20,13 @@ limitations under the License.
 
 #[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
 pub struct AccumulatorWindow {
-    #[serde(rename = "ttl", skip_serializing_if = "Option::is_none")]
-    pub ttl: Option<kube::core::Duration>,
+    #[serde(rename = "timeout", skip_serializing_if = "Option::is_none")]
+    pub timeout: Option<kube::core::Duration>,
 }
 
 impl AccumulatorWindow {
     /// AccumulatorWindow describes a special kind of SessionWindow (similar to Global Window) where output should always have monotonically increasing WM but it can be manipulated through event-time by reordering the messages. NOTE: Quite powerful, should not be abused; it can cause stalling of pipelines and leaks.
     pub fn new() -> AccumulatorWindow {
-        AccumulatorWindow { ttl: None }
+        AccumulatorWindow { timeout: None }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -19641,7 +19641,7 @@`
`19641`	`19641`	`"io.numaproj.numaflow.v1alpha1.AccumulatorWindow": {`
`19642`	`19642`	`"description": "AccumulatorWindow describes a special kind of SessionWindow (similar to Global Window) where output should always have monotonically increasing WM but it can be manipulated through event-time by reordering the messages. NOTE: Quite powerful, should not be abused; it can cause stalling of pipelines and leaks.",`
`19643`	`19643`	`"properties": {`
`19644`		`- "ttl": {`
	`19644`	`+ "timeout": {`
`19645`	`19645`	`"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Duration",`
`19646`	`19646`	`"description": "Timeout is the duration of inactivity after which the state of the accumulator is removed."`
`19647`	`19647`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19646,7 +19646,7 @@`
`19646`	`19646`	`"description": "AccumulatorWindow describes a special kind of SessionWindow (similar to Global Window) where output should always have monotonically increasing WM but it can be manipulated through event-time by reordering the messages. NOTE: Quite powerful, should not be abused; it can cause stalling of pipelines and leaks.",`
`19647`	`19647`	`"type": "object",`
`19648`	`19648`	`"properties": {`
`19649`		`- "ttl": {`
	`19649`	`+ "timeout": {`
`19650`	`19650`	`"description": "Timeout is the duration of inactivity after which the state of the accumulator is removed.",`
`19651`	`19651`	`"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Duration"`
`19652`	`19652`	`}`
Original file line number	Diff line number	Diff line change
`@@ -190,7 +190,7 @@ type SessionWindow struct {`
`190`	`190`	`// NOTE: Quite powerful, should not be abused; it can cause stalling of pipelines and leaks.`
`191`	`191`	`type AccumulatorWindow struct {`
`192`	`192`	`// Timeout is the duration of inactivity after which the state of the accumulator is removed.`
`193`		- Timeout *metav1.Duration `json:"ttl,omitempty" protobuf:"bytes,1,opt,name=timeout"`
	`193`	+ Timeout *metav1.Duration `json:"timeout,omitempty" protobuf:"bytes,1,opt,name=timeout"`
`194`	`194`	`}`
`195`	`195`
`196`	`196`	`// PBQStorage defines the persistence configuration for a vertex.`