Skip to content

Commit d722692

Browse files
manick02tsurdilo
andauthored
#461 Make start param optional (#468)
* Signed-off-by: manick02 <[email protected]> Signing commit Signed-off-by: cb-manick <[email protected]> * adding small text if start is not defined Signed-off-by: Tihomir Surdilovic <[email protected]> * updated the workflow definition structure text for start Signed-off-by: Tihomir Surdilovic <[email protected]> * updated roadmap Signed-off-by: Tihomir Surdilovic <[email protected]> * fixed roadmap text Signed-off-by: Tihomir Surdilovic <[email protected]> Co-authored-by: Tihomir Surdilovic <[email protected]>
1 parent 024e36c commit d722692

File tree

3 files changed

+8
-3
lines changed

3 files changed

+8
-3
lines changed

roadmap/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ _Status description:_
2323
| Status | Description | Comments |
2424
| --- | --- | --- |
2525
| ✔️| Support custom function `type` definition | [spec doc](https://github.com/serverlessworkflow/specification/blob/main/specification.md) |
26+
| ✔️| Workflow "name" no longer a required parameter | [spec doc](https://github.com/serverlessworkflow/specification/blob/main/specification.md) |
27+
| ✔️| Workflow "start" no longer a required parameter| [spec doc](https://github.com/serverlessworkflow/specification/blob/main/specification.md) |
2628
| ✏️️| Support for async action invocation | |
2729
| ✏️️| Start work on TCK | |
2830
| ✏️️| Add more samples | |

schema/workflow.json

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -176,15 +176,13 @@
176176
"required": [
177177
"id",
178178
"specVersion",
179-
"start",
180179
"states"
181180
]
182181
},
183182
{
184183
"required": [
185184
"key",
186185
"specVersion",
187-
"start",
188186
"states"
189187
]
190188
}

specification.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1809,7 +1809,7 @@ definition "id" must be a constant value.
18091809
| dataInputSchema | Used to validate the workflow data input against a defined JSON Schema| string or object | no |
18101810
| [constants](#Workflow-Constants) | Workflow constants | string or object | no |
18111811
| [secrets](#Workflow-Secrets) | Workflow secrets | string or array | no |
1812-
| [start](#Start-Definition) | Workflow start definition | string | yes |
1812+
| [start](#Start-Definition) | Workflow start definition | string | no |
18131813
| specVersion | Serverless Workflow specification release version | string | yes |
18141814
| expressionLang | Identifies the expression language used for workflow expressions. Default value is "jq" | string | no |
18151815
| [timeouts](#Workflow-Timeouts) | Defines the workflow default timeout settings | string or object | no |
@@ -1964,6 +1964,8 @@ If `object` type, it defines a JSON object which contains the constants definiti
19641964
For more information see the [Workflow Constants](#Workflow-Constants) section.
19651965

19661966
The `start` property defines the workflow starting information. For more information see the [start definition](#Start-Definition) section.
1967+
This property is not required. If not defined, the workflow starting state has to be
1968+
the very first state defined in the [workflow states array](#Workflow-States).
19671969

19681970
The `specVersion` property is used to set the Serverless Workflow specification release version
19691971
the workflow markup adheres to.
@@ -4524,6 +4526,9 @@ Event states define that workflow instances are triggered by the existence of th
45244526
Defining a cron-based scheduled starts for the runtime implementations would mean that there needs to be an event service that issues
45254527
the needed events at the defined times to trigger workflow instance creation.
45264528

4529+
Defining a start definition is not required. If it's not defined, the starting workflow
4530+
state has to be the very first state defined in the [workflow stated array](#Workflow-States).
4531+
45274532
##### Schedule Definition
45284533

45294534
`Schedule` definition can have two types, either `string` or `object`.

0 commit comments

Comments
 (0)