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
Clarify EventRef's data parameter is triggerEventRef's payload (#163)
* Clarify EventRef's data parameter is triggerEventRef's payload
Signed-off-by: Lucas Caparelli <[email protected]>
* Make suggested changes
Signed-off-by: Lucas Caparelli <[email protected]>
Copy file name to clipboardExpand all lines: schema/workflow.json
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -376,7 +376,7 @@
376
376
},
377
377
"data": {
378
378
"type": ["string", "object"],
379
-
"description": "If String, expression which selects parts of the states data output to become the data of the produced event. If object a custom object to become the data of produced event."
379
+
"description": "If string type, an expression which selects parts of the states data output to become the data (payload) of the event referenced by 'triggerEventRef'. If object type, a custom object to become the data (payload) of the event referenced by 'triggerEventRef'."
Copy file name to clipboardExpand all lines: specification.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1225,7 +1225,7 @@ function. They can include either static values or reference the states data inp
1225
1225
| --- | --- | --- | --- |
1226
1226
| [triggerEventRef](#Event-Definition) | Reference to the unique name of a `produced` event definition | string | yes |
1227
1227
| [resultEventRef](#Event-Definitions) | Reference to the unique name of a `consumed` event definition | string | yes |
1228
-
| data | If string type, an expression which selects parts of the states data output to become the data (payload) of the produced event. If object type, a custom object to become the data (payload) of trigger/produced event. | string or object | no |
1228
+
| data | If string type, an expression which selects parts of the states data output to become the data (payload) of the event referenced by `triggerEventRef`. If object type, a custom object to become the data (payload) of the event referenced by `triggerEventRef`. | string or object | no |
1229
1229
| contextAttributes | Add additional event extension context attributes to the trigger/produced event | object | no |
1230
1230
1231
1231
<details><summary><strong>Click to view example definition</strong></summary>
@@ -1268,7 +1268,7 @@ eventRef:
1268
1268
References a `produced` and `consumed` [event definitions](#Event-Definition) via the "triggerEventRef" and `resultEventRef` properties, respectively.
1269
1269
1270
1270
The `data` property can have two types: string or object. If it is of string type, it is an expression that can select parts of state data
1271
-
to be used as the trigger/produced event payload. If it is of object type, you can define a custom object to be the event payload.
1271
+
to be used as payload of the event referenced by `triggerEventRef`. If it is of object type, you can define a custom object to be the event payload.
1272
1272
1273
1273
The `contextAttributes` property allows you to add one or more [extension context attributes](https://github.com/cloudevents/spec/blob/master/spec.md#extension-context-attributes)
1274
1274
to the trigger/produced event.
@@ -3915,4 +3915,4 @@ You can find a list of other languages, technologies and specifications related
3915
3915
## License
3916
3916
3917
3917
Serverless Workflow specification operates under the
0 commit comments