docs: Clarify SuspendTemplate.duration. (#9997)

Signed-off-by: Chris Jones <chris.jones@ironcorelabs.com>
argoproj · Nov 15, 2022 · 6f76934 · 6f76934
1 parent fd6aec1
commit 6f76934
Show file tree

Hide file tree

Showing 11 changed files with 17 additions and 13 deletions.
diff --git a/api/jsonschema/schema.json b/api/jsonschema/schema.json
@@ -6398,7 +6398,7 @@
       "description": "SuspendTemplate is a template subtype to suspend a workflow at a predetermined point in time",
       "properties": {
         "duration": {
-          "description": "Duration is the seconds to wait before automatically resuming a template",
+          "description": "Duration is the seconds to wait before automatically resuming a template. Must be a string. Default unit is seconds. Could also be a Duration, e.g.: \"2m\", \"6h\", \"1d\"",
           "type": "string"
         }
       },

diff --git a/api/openapi-spec/swagger.json b/api/openapi-spec/swagger.json
@@ -10302,7 +10302,7 @@
       "type": "object",
       "properties": {
         "duration": {
-          "description": "Duration is the seconds to wait before automatically resuming a template",
+          "description": "Duration is the seconds to wait before automatically resuming a template. Must be a string. Default unit is seconds. Could also be a Duration, e.g.: \"2m\", \"6h\", \"1d\"",
           "type": "string"
         }
       }

diff --git a/docs/executor_swagger.md b/docs/executor_swagger.md
@@ -4337,7 +4337,8 @@ Namespaces that do not pre-exist within StorageOS will be created.
 
 | Name | Type | Go type | Required | Default | Description | Example |
 |------|------|---------|:--------:| ------- |-------------|---------|
-| duration | string| `string` |  | | Duration is the seconds to wait before automatically resuming a template |  |
+| duration | string| `string` |  | | Duration is the seconds to wait before automatically resuming a template. Must be a string. Default unit is seconds.
+Could also be a Duration, e.g.: "2m", "6h", "1d" |  |
 
 
 

diff --git a/docs/fields.md b/docs/fields.md
@@ -3137,7 +3137,7 @@ SuspendTemplate is a template subtype to suspend a workflow at a predetermined p
 ### Fields
 | Field Name | Field Type | Description   |
 |:----------:|:----------:|---------------|
-|`duration`|`string`|Duration is the seconds to wait before automatically resuming a template|
+|`duration`|`string`|Duration is the seconds to wait before automatically resuming a template. Must be a string. Default unit is seconds. Could also be a Duration, e.g.: "2m", "6h", "1d"|
 
 ## LabelValueFrom
 

diff --git a/pkg/apis/workflow/v1alpha1/generated.proto b/pkg/apis/workflow/v1alpha1/generated.proto
diff --git a/pkg/apis/workflow/v1alpha1/openapi_generated.go b/pkg/apis/workflow/v1alpha1/openapi_generated.go
diff --git a/pkg/apis/workflow/v1alpha1/workflow_types.go b/pkg/apis/workflow/v1alpha1/workflow_types.go
@@ -3062,7 +3062,8 @@ func (t *DAGTask) ShouldExpand() bool {
 
 // SuspendTemplate is a template subtype to suspend a workflow at a predetermined point in time
 type SuspendTemplate struct {
-	// Duration is the seconds to wait before automatically resuming a template
+	// Duration is the seconds to wait before automatically resuming a template. Must be a string. Default unit is seconds.
+	// Could also be a Duration, e.g.: "2m", "6h", "1d"
 	Duration string `json:"duration,omitempty" protobuf:"bytes,1,opt,name=duration"`
 }
 

diff --git a/pkg/plugins/executor/swagger.yml b/pkg/plugins/executor/swagger.yml
@@ -3908,8 +3908,9 @@ definitions:
       predetermined point in time
     properties:
       duration:
-        description: Duration is the seconds to wait before automatically resuming
-          a template
+        description: |-
+          Duration is the seconds to wait before automatically resuming a template. Must be a string. Default unit is seconds.
+          Could also be a Duration, e.g.: "2m", "6h", "1d"
         type: string
     type: object
   Synchronization:

diff --git a/sdks/java/client/docs/IoArgoprojWorkflowV1alpha1SuspendTemplate.md b/sdks/java/client/docs/IoArgoprojWorkflowV1alpha1SuspendTemplate.md
@@ -8,7 +8,7 @@ SuspendTemplate is a template subtype to suspend a workflow at a predetermined p
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**duration** | **String** | Duration is the seconds to wait before automatically resuming a template |  [optional]
+**duration** | **String** | Duration is the seconds to wait before automatically resuming a template. Must be a string. Default unit is seconds. Could also be a Duration, e.g.: \&quot;2m\&quot;, \&quot;6h\&quot;, \&quot;1d\&quot; |  [optional]
 
 
 
diff --git a/sdks/python/client/argo_workflows/model/io_argoproj_workflow_v1alpha1_suspend_template.py b/sdks/python/client/argo_workflows/model/io_argoproj_workflow_v1alpha1_suspend_template.py
diff --git a/sdks/python/client/docs/IoArgoprojWorkflowV1alpha1SuspendTemplate.md b/sdks/python/client/docs/IoArgoprojWorkflowV1alpha1SuspendTemplate.md