Skip to content

Clarify EventRef's data parameter is triggerEventRef's payload #163

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 26, 2020
Merged

Clarify EventRef's data parameter is triggerEventRef's payload #163

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8c20bed
Clarify EventRef's data parameter is triggerEventRef's payload
LCaparelli Oct 26, 2020
a298026
Make suggested changes
LCaparelli Oct 26, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions schema/workflow.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -376,7 +376,7 @@
},
"data": {
"type": ["string", "object"],
"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."
"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'."
},
"contextAttributes": {
"type": "object",
Expand Down Expand Up @@ -1874,4 +1874,4 @@
"required": []
}
}
}
}
6 changes: 3 additions & 3 deletions specification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1225,7 +1225,7 @@ function. They can include either static values or reference the states data inp
| --- | --- | --- | --- |
| [triggerEventRef](#Event-Definition) | Reference to the unique name of a `produced` event definition | string | yes |
| [resultEventRef](#Event-Definitions) | Reference to the unique name of a `consumed` event definition | string | yes |
| 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 |
| 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 |
| contextAttributes | Add additional event extension context attributes to the trigger/produced event | object | no |

<details><summary><strong>Click to view example definition</strong></summary>
Expand Down Expand Up @@ -1268,7 +1268,7 @@ eventRef:
References a `produced` and `consumed` [event definitions](#Event-Definition) via the "triggerEventRef" and `resultEventRef` properties, respectively.

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
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.
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.

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)
to the trigger/produced event.
Expand Down Expand Up @@ -3915,4 +3915,4 @@ You can find a list of other languages, technologies and specifications related
## License

Serverless Workflow specification operates under the
[Apache License version 2.0](LICENSE).
[Apache License version 2.0](LICENSE).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wonder why both of your PRs include this change? Maybe some newline char issue?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, it's just an additional line break vim added automatically to the end of the file.

Using od we can see the master branch has no line break:

╰─ od -c specification.md
# output omitted
0373300       W   o   r   k   f   l   o   w       s   p   e   c   i   f
0373320   i   c   a   t   i   o   n       o   p   e   r   a   t   e   s
0373340       u   n   d   e   r       t   h   e  \n   [   A   p   a   c
0373360   h   e       L   i   c   e   n   s   e       v   e   r   s   i
0373400   o   n       2   .   0   ]   (   L   I   C   E   N   S   E   )
0373420   .
0373421

From this branch:

╰─ od -c specification.md
# output omitted
0373340   m   d   )   .  \n  \n   #   #       L   i   c   e   n   s   e
0373360  \n  \n   S   e   r   v   e   r   l   e   s   s       W   o   r
0373400   k   f   l   o   w       s   p   e   c   i   f   i   c   a   t
0373420   i   o   n       o   p   e   r   a   t   e   s       u   n   d
0373440   e   r       t   h   e  \n   [   A   p   a   c   h   e       L
0373460   i   c   e   n   s   e       v   e   r   s   i   o   n       2
0373500   .   0   ]   (   L   I   C   E   N   S   E   )   .  \n
0373516