@@ -643,7 +643,7 @@ a workflow with a single event state and show how data filters can be combined.
643643
644644` ` ` json
645645{
646- "name": "GreetCustomersWorkflow ",
646+ "name": "greet-customers-workflow ",
647647 "description": "Greet Customers when they arrive",
648648 "version": "1.0.0",
649649 "specVersion": "0.8",
@@ -1910,7 +1910,7 @@ we can use this expression in the workflow "version" parameter:
19101910
19111911` ` ` json
19121912{
1913- "name": "MySampleWorkflow ",
1913+ "name": "my-sample-workflow ",
19141914 "description": "Sample Workflow",
19151915 "version": "${ .inputVersion }",
19161916 "specVersion": "0.8"
@@ -1925,10 +1925,10 @@ definition "name" must be a constant value.
19251925
19261926| Parameter | Description | Type | Required |
19271927| --- | --- | --- | --- |
1928- | name | Workflow definition unique identifier ( which must be human readable) | string | yes |
1929- | version | Workflow version. MUST respect the [semantic versioning](https://semver.org/) format. If not provided, latest is assumed | string | no |
1928+ | name | The name that identifies the workflow definition, and which, when combined with its version, forms a unique identifier. | string | yes |
1929+ | version | Workflow version. MUST respect the [semantic versioning](https://semver.org/) format. If not provided, ` latest` is assumed | string | no |
19301930| description | Workflow description | string | no |
1931- | key | Expression that will be used to generate a domain-specific workflow instance identifier | string | no |
1931+ | key | Optional expression that will be used to generate a domain-specific workflow instance identifier | string | no |
19321932| annotations | List of helpful terms describing the workflows intended purpose, subject areas, or other important qualities | array | no |
19331933| dataInputSchema | Used to validate the workflow data input against a defined JSON Schema| string or object | no |
19341934| dataOutputSchema | Used to validate the workflow data output against a defined JSON Schema| string or object | no |
@@ -1962,7 +1962,7 @@ definition "name" must be a constant value.
19621962
19631963` ` ` json
19641964{
1965- "name": "sampleWorkflow ",
1965+ "name": "sample-workflow ",
19661966 "version": "1.0.0",
19671967 "specVersion": "0.8",
19681968 "description": "Sample Workflow",
@@ -1979,7 +1979,7 @@ definition "name" must be a constant value.
19791979<td valign="top">
19801980
19811981` ` ` yaml
1982- name: sampleWorkflow
1982+ name: sample-workflow
19831983version: '1.0.0'
19841984specVersion: '0.8'
19851985description: Sample Workflow
@@ -2161,7 +2161,7 @@ Here is an example of using external resource for function definitions:
21612161
21622162` ` ` json
21632163{
2164- "name": "sampleWorkflow ",
2164+ "name": "sample-workflow ",
21652165 "version": "1.0.0",
21662166 "specVersion": "0.8",
21672167 "description": "Sample Workflow",
@@ -2197,7 +2197,7 @@ Here is an example of using external resource for event definitions:
21972197
21982198` ` ` json
21992199{
2200- "name": "sampleWorkflow ",
2200+ "name": "sample-workflow ",
22012201 "version": "1.0.0",
22022202 "specVersion": "0.8",
22032203 "description": "Sample Workflow",
@@ -2361,7 +2361,7 @@ Serverless Workflow defines the following Workflow States:
23612361<td valign="top">
23622362
23632363` ` ` yaml
2364- name: MonitorVitals
2364+ name: monitor-vitals
23652365type: event
23662366exclusive: true
23672367onEvents:
@@ -3140,7 +3140,7 @@ and our workflow is defined as:
31403140
31413141` ` ` json
31423142{
3143- "name": "SendConfirmationForCompletedOrders ",
3143+ "name": "send-confirmation-for-completed-orders ",
31443144 "version": "1.0.0",
31453145 "specVersion": "0.8",
31463146 "start": "send-confirm-state",
@@ -3176,7 +3176,7 @@ and our workflow is defined as:
31763176<td valign="top">
31773177
31783178` ` ` yaml
3179- name: SendConfirmationForCompletedOrders
3179+ name: send-confirmation-for-completed-orders
31803180version: '1.0.0'
31813181specVersion: '0.8'
31823182start: send-confirm-state
@@ -3454,7 +3454,7 @@ Example of a function definition configured to use an [auth definition](#Auth-De
34543454
34553455` ` ` yaml
34563456functions:
3457- - name: SecuredFunctionInvocation
3457+ - name: secured-function-invocation
34583458 operation: https://test.com/swagger.json#HelloWorld
34593459 authRef: My Basic Auth
34603460` ` `
@@ -3463,7 +3463,7 @@ Example of a function definition configured to use an [auth definition](#Auth-De
34633463
34643464` ` ` yaml
34653465functions:
3466- - name: SecuredFunctionInvocation
3466+ - name: secured-function-invocation
34673467 operation: https://test.com/swagger.json#HelloWorld
34683468 authRef:
34693469 resource: My Basic Auth
@@ -3476,11 +3476,11 @@ This is done to avoid unnecessary repetitions of [auth definition](#Auth-Definit
34763476
34773477` ` ` yaml
34783478functions:
3479- - name: MySecuredFunction1
3479+ - name: secured-function-1
34803480 operation: https://secure.resources.com/myapi.json#helloWorld
34813481 authRef:
34823482 resource: My ApiKey Auth
3483- - name: MySecuredFunction2
3483+ - name: secured-function-2
34843484 operation: https://secure.resources.com/myapi.json#holaMundo
34853485` ` `
34863486
@@ -5141,7 +5141,7 @@ Let's take a look at an example of additional properties:
51415141
51425142` ` ` json
51435143{
5144- "name": "myworkflow ",
5144+ "name": "my-workflow ",
51455145 "version": "1.0.0",
51465146 "specVersion": "0.8",
51475147 "description": "My Test Workflow",
@@ -5159,7 +5159,7 @@ Note the same can be also specified using workflow metadata, which is the prefer
51595159
51605160` ` ` json
51615161{
5162- "name": "myworkflow ",
5162+ "name": "my-workflow ",
51635163 "version": "1.0.0",
51645164 "specVersion": "0.8",
51655165 "description": "Py Test Workflow",
@@ -5555,18 +5555,18 @@ actions:
55555555</tr>
55565556</table>
55575557
5558- In our example the first action named `MyFirstFunction ` is going to be retried according to the `FirstRetryStrategy `
5558+ In our example the first action named `my-first-function ` is going to be retried according to the `first-retry-strategy `
55595559retry policy
55605560for all errors except `SomeErrorOne` and `SomeErrorTwo`.
55615561
5562- The seconds action named `MySecondFunction ` is going to be retried according to the `SecondRetryStrategy `
5562+ The seconds action named `my-second-function ` is going to be retried according to the `second-retry-strategy `
55635563retry policy
55645564for all errors except `SomeErrorTwo` and `SomeErrorThree`.
55655565
5566- The third action named `MyThirdFunction ` is going to retried according to the default runtime retry policy.
5566+ The third action named `my-third-function ` is going to retried according to the default runtime retry policy.
55675567It will be retried for all errors both known (checked) as well as unknown (unckecked).
55685568
5569- The fourth action named `MyFourthFunction ` is going to be retried according to the `DoNotRetryStrategy `
5569+ The fourth action named `my-fourth-function ` is going to be retried according to the `no-retry-strategy `
55705570retry policy which has the `maxAttempts` property set to `1`, meaning that this action will not be retried.
55715571
55725572# ## Workflow Timeouts
@@ -5587,8 +5587,7 @@ timeout settings should take in effect.
55875587To give an example, let's say that in our workflow definition we define the timeout for state execution :
55885588
55895589` ` ` json
5590- {
5591- "name": "testWorkflow",
5590+ "name": "test-workflow",
55925591 ...
55935592 "timeouts": {
55945593 ...
@@ -6304,7 +6303,7 @@ Here is an example of metadata attached to the core workflow definition:
63046303
63056304` ` ` json
63066305{
6307- "name": "processSalesOrders ",
6306+ "name": "process-sales-orders ",
63086307 "description": "Process Sales Orders",
63096308 "version": "1.0.0",
63106309 "specVersion": "0.8",
@@ -6340,7 +6339,7 @@ Implementations may use this keyword to give access to any relevant information
63406339` ` ` json
63416340
63426341{
6343- "name": "processSalesOrders ",
6342+ "name": "process-sales-orders ",
63446343 "description": "Process Sales Orders",
63456344 "version": "1.0.0",
63466345 "specVersion": "0.8",
0 commit comments