Skip to content

Commit

Permalink
docs: suspend duration unit document #11558 (#11575)
Browse files Browse the repository at this point in the history
  • Loading branch information
sonbui00 authored Aug 15, 2023
1 parent 1fd6e40 commit 6cd3e81
Show file tree
Hide file tree
Showing 13 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion api/jsonschema/schema.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion api/openapi-spec/swagger.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/executor_swagger.md
Original file line number Diff line number Diff line change
Expand Up @@ -4354,7 +4354,7 @@ 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. Must be a string. Default unit is seconds.
Could also be a Duration, e.g.: "2m", "6h", "1d" | |
Could also be a Duration, e.g.: "2m", "6h" | |



Expand Down
2 changes: 1 addition & 1 deletion docs/fields.md
Original file line number Diff line number Diff line change
Expand Up @@ -3157,7 +3157,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. Must be a string. Default unit is seconds. Could also be a Duration, e.g.: "2m", "6h", "1d"|
|`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"|

## LabelValueFrom

Expand Down
2 changes: 1 addition & 1 deletion docs/walk-through/suspending.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ spec:

- name: delay
suspend:
duration: "20" # Must be a string. Default unit is seconds. Could also be a Duration, e.g.: "2m", "6h", "1d"
duration: "20" # Must be a string. Default unit is seconds. Could also be a Duration, e.g.: "2m", "6h"

- name: whalesay
container:
Expand Down
2 changes: 1 addition & 1 deletion examples/suspend-template.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ spec:

- name: delay
suspend:
duration: "20" # Must be a string. Default unit is seconds. Could also be a Duration, e.g.: "2m", "6h", "1d"
duration: "20" # Must be a string. Default unit is seconds. Could also be a Duration, e.g.: "2m", "6h"

- name: whalesay
container:
Expand Down
2 changes: 1 addition & 1 deletion pkg/apis/workflow/v1alpha1/generated.proto

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion pkg/apis/workflow/v1alpha1/openapi_generated.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion pkg/apis/workflow/v1alpha1/workflow_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -3181,7 +3181,7 @@ 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. Must be a string. Default unit is seconds.
// Could also be a Duration, e.g.: "2m", "6h", "1d"
// Could also be a Duration, e.g.: "2m", "6h"
Duration string `json:"duration,omitempty" protobuf:"bytes,1,opt,name=duration"`
}

Expand Down
2 changes: 1 addition & 1 deletion pkg/plugins/executor/swagger.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3929,7 +3929,7 @@ definitions:
duration:
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"
Could also be a Duration, e.g.: "2m", "6h"
type: string
type: object
Synchronization:
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 6cd3e81

Please sign in to comment.