diff --git a/api/jsonschema/schema.json b/api/jsonschema/schema.json index b853e72e2f53..e18ea4ee1285 100644 --- a/api/jsonschema/schema.json +++ b/api/jsonschema/schema.json @@ -4972,7 +4972,7 @@ "description": "LastScheduleTime is the last time the CronWorkflow was scheduled" }, "phase": { - "description": "v3.6 and after: Phase is an enum of Active or Stopped. It changes to Stopped when stopStrategy.condition is true", + "description": "v3.6 and after: Phase is an enum of Active or Stopped. It changes to Stopped when stopStrategy.expression is true", "type": "string" }, "succeeded": { diff --git a/api/openapi-spec/swagger.json b/api/openapi-spec/swagger.json index 7ccfacd9d8fe..bc16fe9238f4 100644 --- a/api/openapi-spec/swagger.json +++ b/api/openapi-spec/swagger.json @@ -9005,7 +9005,7 @@ "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time" }, "phase": { - "description": "v3.6 and after: Phase is an enum of Active or Stopped. It changes to Stopped when stopStrategy.condition is true", + "description": "v3.6 and after: Phase is an enum of Active or Stopped. It changes to Stopped when stopStrategy.expression is true", "type": "string" }, "succeeded": { diff --git a/docs/cron-workflows.md b/docs/cron-workflows.md index cdc7b440420c..4ea58fcc0b3d 100644 --- a/docs/cron-workflows.md +++ b/docs/cron-workflows.md @@ -149,8 +149,8 @@ The second will not run because of the `when` expression, which prevents this wo > v3.6 and after -You can configure a `CronWorkflow` to automatically stop based on an [expression](variables.md#expression) with `stopStrategy.condition`. -You can use the [variables](variables.md#cronworkflows) `cronworkflow.failed` and `cronworkflow.succeede2d`. +You can configure a `CronWorkflow` to automatically stop based on an [expression](variables.md#expression) with `stopStrategy.expression`. +You can use the [variables](variables.md#cronworkflows) `cronworkflow.failed` and `cronworkflow.succeeded`. For example, if you want to stop scheduling new workflows after one success: diff --git a/docs/fields.md b/docs/fields.md index fce94b502d96..19ef63bd5d76 100644 --- a/docs/fields.md +++ b/docs/fields.md @@ -1314,7 +1314,7 @@ CronWorkflowStatus is the status of a CronWorkflow |`conditions`|`Array<`[`Condition`](#condition)`>`|Conditions is a list of conditions the CronWorkflow may have| |`failed`|`integer`|v3.6 and after: Failed counts how many times child workflows failed| |`lastScheduledTime`|[`Time`](#time)|LastScheduleTime is the last time the CronWorkflow was scheduled| -|`phase`|`string`|v3.6 and after: Phase is an enum of Active or Stopped. It changes to Stopped when stopStrategy.condition is true| +|`phase`|`string`|v3.6 and after: Phase is an enum of Active or Stopped. It changes to Stopped when stopStrategy.expression is true| |`succeeded`|`integer`|v3.6 and after: Succeeded counts how many times child workflows succeeded| ## WorkflowEventBindingSpec diff --git a/pkg/apis/workflow/v1alpha1/cron_workflow_types.go b/pkg/apis/workflow/v1alpha1/cron_workflow_types.go index 65cb6884eb18..649329448046 100644 --- a/pkg/apis/workflow/v1alpha1/cron_workflow_types.go +++ b/pkg/apis/workflow/v1alpha1/cron_workflow_types.go @@ -90,7 +90,7 @@ type CronWorkflowStatus struct { Succeeded int64 `json:"succeeded" protobuf:"varint,4,rep,name=succeeded"` // v3.6 and after: Failed counts how many times child workflows failed Failed int64 `json:"failed" protobuf:"varint,5,rep,name=failed"` - // v3.6 and after: Phase is an enum of Active or Stopped. It changes to Stopped when stopStrategy.condition is true + // v3.6 and after: Phase is an enum of Active or Stopped. It changes to Stopped when stopStrategy.expression is true Phase CronWorkflowPhase `json:"phase" protobuf:"varint,6,rep,name=phase"` } diff --git a/pkg/apis/workflow/v1alpha1/generated.proto b/pkg/apis/workflow/v1alpha1/generated.proto index 95eddbdf358b..5ae06f70e020 100644 --- a/pkg/apis/workflow/v1alpha1/generated.proto +++ b/pkg/apis/workflow/v1alpha1/generated.proto @@ -529,7 +529,7 @@ message CronWorkflowStatus { // v3.6 and after: Failed counts how many times child workflows failed optional int64 failed = 5; - // v3.6 and after: Phase is an enum of Active or Stopped. It changes to Stopped when stopStrategy.condition is true + // v3.6 and after: Phase is an enum of Active or Stopped. It changes to Stopped when stopStrategy.expression is true optional string phase = 6; } diff --git a/pkg/apis/workflow/v1alpha1/openapi_generated.go b/pkg/apis/workflow/v1alpha1/openapi_generated.go index c8215312264c..a89ff0719d32 100644 --- a/pkg/apis/workflow/v1alpha1/openapi_generated.go +++ b/pkg/apis/workflow/v1alpha1/openapi_generated.go @@ -2384,7 +2384,7 @@ func schema_pkg_apis_workflow_v1alpha1_CronWorkflowStatus(ref common.ReferenceCa }, "phase": { SchemaProps: spec.SchemaProps{ - Description: "v3.6 and after: Phase is an enum of Active or Stopped. It changes to Stopped when stopStrategy.condition is true", + Description: "v3.6 and after: Phase is an enum of Active or Stopped. It changes to Stopped when stopStrategy.expression is true", Default: "", Type: []string{"string"}, Format: "", diff --git a/sdks/java/client/docs/IoArgoprojWorkflowV1alpha1CronWorkflowStatus.md b/sdks/java/client/docs/IoArgoprojWorkflowV1alpha1CronWorkflowStatus.md index 5d7af2d69478..f812029dfde1 100644 --- a/sdks/java/client/docs/IoArgoprojWorkflowV1alpha1CronWorkflowStatus.md +++ b/sdks/java/client/docs/IoArgoprojWorkflowV1alpha1CronWorkflowStatus.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **conditions** | [**List<IoArgoprojWorkflowV1alpha1Condition>**](IoArgoprojWorkflowV1alpha1Condition.md) | Conditions is a list of conditions the CronWorkflow may have | **failed** | **Integer** | v3.6 and after: Failed counts how many times child workflows failed | **lastScheduledTime** | **java.time.Instant** | | -**phase** | **String** | v3.6 and after: Phase is an enum of Active or Stopped. It changes to Stopped when stopStrategy.condition is true | +**phase** | **String** | v3.6 and after: Phase is an enum of Active or Stopped. It changes to Stopped when stopStrategy.expression is true | **succeeded** | **Integer** | v3.6 and after: Succeeded counts how many times child workflows succeeded | diff --git a/sdks/python/client/argo_workflows/model/io_argoproj_workflow_v1alpha1_cron_workflow_status.py b/sdks/python/client/argo_workflows/model/io_argoproj_workflow_v1alpha1_cron_workflow_status.py index df94e4a5df77..9c070e40456c 100644 --- a/sdks/python/client/argo_workflows/model/io_argoproj_workflow_v1alpha1_cron_workflow_status.py +++ b/sdks/python/client/argo_workflows/model/io_argoproj_workflow_v1alpha1_cron_workflow_status.py @@ -126,7 +126,7 @@ def _from_openapi_data(cls, active, conditions, failed, last_scheduled_time, pha conditions ([IoArgoprojWorkflowV1alpha1Condition]): Conditions is a list of conditions the CronWorkflow may have failed (int): v3.6 and after: Failed counts how many times child workflows failed last_scheduled_time (datetime): Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. - phase (str): v3.6 and after: Phase is an enum of Active or Stopped. It changes to Stopped when stopStrategy.condition is true + phase (str): v3.6 and after: Phase is an enum of Active or Stopped. It changes to Stopped when stopStrategy.expression is true succeeded (int): v3.6 and after: Succeeded counts how many times child workflows succeeded Keyword Args: @@ -221,7 +221,7 @@ def __init__(self, active, conditions, failed, last_scheduled_time, phase, succe conditions ([IoArgoprojWorkflowV1alpha1Condition]): Conditions is a list of conditions the CronWorkflow may have failed (int): v3.6 and after: Failed counts how many times child workflows failed last_scheduled_time (datetime): Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. - phase (str): v3.6 and after: Phase is an enum of Active or Stopped. It changes to Stopped when stopStrategy.condition is true + phase (str): v3.6 and after: Phase is an enum of Active or Stopped. It changes to Stopped when stopStrategy.expression is true succeeded (int): v3.6 and after: Succeeded counts how many times child workflows succeeded Keyword Args: diff --git a/sdks/python/client/docs/IoArgoprojWorkflowV1alpha1CronWorkflowStatus.md b/sdks/python/client/docs/IoArgoprojWorkflowV1alpha1CronWorkflowStatus.md index 369ac94ffa06..1da5cc459e61 100644 --- a/sdks/python/client/docs/IoArgoprojWorkflowV1alpha1CronWorkflowStatus.md +++ b/sdks/python/client/docs/IoArgoprojWorkflowV1alpha1CronWorkflowStatus.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **conditions** | [**[IoArgoprojWorkflowV1alpha1Condition]**](IoArgoprojWorkflowV1alpha1Condition.md) | Conditions is a list of conditions the CronWorkflow may have | **failed** | **int** | v3.6 and after: Failed counts how many times child workflows failed | **last_scheduled_time** | **datetime** | Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. | -**phase** | **str** | v3.6 and after: Phase is an enum of Active or Stopped. It changes to Stopped when stopStrategy.condition is true | +**phase** | **str** | v3.6 and after: Phase is an enum of Active or Stopped. It changes to Stopped when stopStrategy.expression is true | **succeeded** | **int** | v3.6 and after: Succeeded counts how many times child workflows succeeded | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]