You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: specification.md
+47-1Lines changed: 47 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1394,7 +1394,7 @@ definition "id" must be a constant value.
1394
1394
| [functions](#Function-Definition) | Workflow function definitions. Can be either inline function definitions (if array) or URI pointing to a resource containing json/yaml function definitions (if string) | array or string| no |
1395
1395
| [retries](#Retry-Definition) | Workflow retries definitions. Can be either inline retries definitions (if array) or URI pointing to a resource containing json/yaml retry definitions (if string) | array or string| no |
1396
1396
| [states](#State-Definition) | Workflow states | array | yes |
1397
-
| [metadata](#Workflow-Metadata) | Metadata information| object | no |
1397
+
| [metadata](#Workflow-Metadata) | Metadata information| object | no |
1398
1398
1399
1399
<details><summary><strong>Click to view example definition</strong></summary>
1400
1400
<p>
@@ -1591,6 +1591,52 @@ This allows you to explicitly model workflows where an instance should be kept a
1591
1591
1592
1592
You can reference the [specification examples](#Examples) to see the `keepActive` property in action.
1593
1593
1594
+
#### Additional Properties
1595
+
1596
+
Specifying additional properties, namely properties which are not defined by the specification
1597
+
are only allowed in the [Workflow Definition](#Workflow-Definition-Structure).
1598
+
Additional properties serve the same purpose as [Workflow Metadata](#Workflow-Metadata).
1599
+
They allow you to enrich the workflow definition with custom information.
1600
+
1601
+
Additional properties, just like workflow metadata, should not affect workflow execution.
1602
+
Implementations may choose to use additional properties or ignore them.
1603
+
1604
+
It is recommended to use workflow metadata instead of additional properties in the workflow definition.
1605
+
1606
+
Let's take a look at an example of additional properties:
1607
+
1608
+
```json
1609
+
{
1610
+
"id": "myworkflow",
1611
+
"version": "1.0",
1612
+
"name": "My Test Workflow",
1613
+
"start": "My First State",
1614
+
"loglevel": "Info",
1615
+
"environment": "Production",
1616
+
"category": "Sales",
1617
+
"states": [ ... ]
1618
+
}
1619
+
```
1620
+
1621
+
In this example, we specify the `loglevel`, `environment`, and `category` additional properties.
1622
+
1623
+
Note the same can be also specified using workflow metadata, which is the preferred approach:
0 commit comments