Fixes inconsistencies between listen and emit#926
Fixes inconsistencies between listen and emit#926JBBianchi wants to merge 0 commit intoserverlessworkflow:mainfrom
listen and emit#926Conversation
There was a problem hiding this comment.
Looks great to me, thank you so much! ❤️
Aside from a small typo, I'm wondering whether the term event applies to with.
IMHO, we should find a term that best describes it: as a matter of fact, it's not an event, which is a term that could confuse users, but rather eventProperties or something like that. WDYT?
Signed-off-by: Jean-Baptiste Bianchi <jb.bianchi@neuroglia.io>
|
@JBBianchi can you please rebase? |
ricardozanini
left a comment
ricardozanini
left a comment
There was a problem hiding this comment.
Great work, @JBBianchi! Just left a few comments if you don't mind. Also, do you mind adding a few examples to validate the change? Thanks!
dsl-reference.md
Outdated
There was a problem hiding this comment.
Why do we need this \ scape char here?
There was a problem hiding this comment.
Otherwise it breaks the table formatting (like adding an extra cell).
dsl-reference.md
Outdated
There was a problem hiding this comment.
Do we need the double anchor?
There was a problem hiding this comment.
It's a mistake, good catch.
dsl-reference.md
Outdated
dsl-reference.md
Outdated
There was a problem hiding this comment.
| An event object typically includes details such as the event type, source, timestamp, and unique identifier, along with any relevant data payload. The [Cloud Events specification](https://cloudevents.io/), favored by Serveless Workflow, standardizes this structure to ensure interoperability across different systems and services. | |
| An event object typically includes details such as the event type, source, timestamp, and unique identifier along with any relevant data payload. The [Cloud Events specification](https://cloudevents.io/), favored by Serverless Workflow, standardizes this structure to ensure interoperability across different systems and services. |
dsl-reference.md
Outdated
There was a problem hiding this comment.
| | type | `string` | `no` | Describes the type of event related to the originating occurrence. `source` + `id` is unique for each distinct event.<br>*Required when emitting an event using `emit.event.with`.* | | |
| | type | `string` | `no` | Describes the type of event related to the originating occurrence. <br>*Required when emitting an event using `emit.event.with`.* | |
dsl-reference.md
Outdated
There was a problem hiding this comment.
Worth linking to https://github.com/cloudevents/spec/blob/main/cloudevents/spec.md#extension-context-attributes. Any properties not listed in the CE spec are considered to be extensions.
dsl-reference.md
Outdated
There was a problem hiding this comment.
| | from | `string`<br>`object` | `no` | A [runtime expression](dsl.md##runtime-expressions), if any, used to filter and/or mutate the workflow/task input. | | |
| | from | `string`<br>`object` | `no` | A [runtime expression](dsl.md#runtime-expressions), if any, used to filter and/or mutate the workflow/task input. | |
dsl-reference.md
Outdated
There was a problem hiding this comment.
So this type in the schema can be the new definition introduced by @matthias-pichler-warrify and also a pattern? Maybe it's worth updating the schema?
dsl-reference.md
Outdated
There was a problem hiding this comment.
| | as | `string`<br>`object` | `no` | A [runtime expression](dsl.md##runtime-expressions), if any, used to filter and/or mutate the workflow/task output. | | |
| | as | `string`<br>`object` | `no` | A [runtime expression](dsl.md#runtime-expressions), if any, used to filter and/or mutate the workflow/task output. | |
schema/workflow.yaml
Outdated
There was a problem hiding this comment.
This one could be a OneOf of expression, pattern, or eventProperties.
There was a problem hiding this comment.
I'm not sure about that one. @cdavernas @fjtirado @matthias-pichler-warrify wdyt ?
JBBianchi
force-pushed
the
fix-917-semantic-inconsistencies-listen-vs-emit
branch
from
2bab1f5 to
f25a9f5
Compare
3 participants
Please specify parts of this PR update:
Discussion or Issue link:
Closes #917 (and other little minor typo)
What this PR does:
listenandemiteventsection in the specification documentationemitin the specification documentationeventdefinition in the JSON schema and referenced it inemit.event.withandeventFilter.withendpointby addingstringendpointsection in the specification documentationhttps://https://implictlyAdditional information:
-