Updating data filters (#278)

* Updating data filters

Signed-off-by: Tihomir Surdilovic <[email protected]>

* fix sentence

Signed-off-by: Tihomir Surdilovic <[email protected]>

* fix sentence

Signed-off-by: Tihomir Surdilovic <[email protected]>

* fix sentence

Signed-off-by: Tihomir Surdilovic <[email protected]>

* fix sentence

Signed-off-by: Tihomir Surdilovic <[email protected]>

* fixes per Ricardos comments

Signed-off-by: Tihomir Surdilovic <[email protected]>

* fixes per Ricardos comments

Signed-off-by: Tihomir Surdilovic <[email protected]>

* Fixes per Jorgens comments

Signed-off-by: Tihomir Surdilovic <[email protected]>

* Fixes per Jorgens comments

Signed-off-by: Tihomir Surdilovic <[email protected]>

* Fixes per Jorgens comments

Signed-off-by: Tihomir Surdilovic <[email protected]>

Author: Tihomir Surdilovic

comparisons/comparison-argo.md

@@ -404,7 +404,7 @@ states:
   actions:
   - functionRef: gen-random-int-bash
     actionDataFilter:
-      dataResultsPath: "${ .results }"
+      results: "${ .results }"
   transition: print-message
 - name: print-message
   type: operation
@@ -581,7 +581,7 @@ states:
   actions:
   - functionRef: flip-coin-function
     actionDataFilter:
-      dataResultsPath: "${ .flip.result }"
+      results: "${ .flip.result }"
   transition: show-flip-results
 - name: show-flip-results
   type: switch
@@ -595,14 +595,14 @@ states:
   actions:
   - functionRef: echo
     actionDataFilter:
-      dataResultsPath: it was heads
+      results: it was heads
   end: true
 - name: show-results-tails
   type: operation
   actions:
   - functionRef: echo
     actionDataFilter:
-      dataResultsPath: it was tails
+      results: it was tails
   end: true
 ```
 
@@ -761,7 +761,7 @@ states:
   actions:
   - functionRef: flip-coin-function
     actionDataFilter:
-      dataResultsPath: "${ .steps.flip-coin.outputs.result }" 
+      results: "${ .steps.flip-coin.outputs.result }" 
   transition: flip-coin-check
 - name: flip-coin-check
   type: switch

comparisons/comparison-brigade.md

@@ -403,7 +403,7 @@ states:
   - eventRefs:
     - execEvent
     eventDataFilter:
-      dataOutputPath: "${ .event }"
+      results: "${ .event }"
     actions:
     - name: eventInfoAction
       functionRef:
@@ -484,18 +484,18 @@ states:
   - eventRefs:
     - execEvent
     eventDataFilter:
-      dataOutputPath: "${ .event }"
+      data: "${ .event }"
     actions:
     - name: helloAction
       actionDataFilter:
-        dataResultsPath: "${ .helloResult }"
+        results: "${ .helloResult }"
       functionRef:
         refName: greetingFunction
         arguments:
           message: hello
     - name: worldAction
       actionDataFilter:
-        dataResultsPath: "${ .worldResults }"
+        results: "${ .worldResults }"
       functionRef:
         refName: greetingAction
         arguments:
@@ -572,7 +572,7 @@ states:
     - execEvent
     actions: []
     eventDataFilter:
-      dataOutputPath: "${ .execEvent }"
+      data: "${ .execEvent }"
   transition:
     nextState: NextEventState
     produceEvents:
@@ -590,7 +590,7 @@ states:
   - eventRefs:
     - nextEvent
     eventDataFilter:
-      dataOutputPath: "${ .nextEvent }"
+      data: "${ .nextEvent }"
     actions:
     - name: consoleLogAction
       functionRef:

comparisons/comparison-cadence.md

@@ -201,7 +201,7 @@ states:
       arguments:
         filename: "${ .file.name }"
     actionDataFilter:
-      dataResultsPath: "${ .processed }"
+      results: "${ .processed }"
   - functionRef:
       refName: uploadfunction
       arguments:

comparisons/comparison-google-cloud-workflows.md

@@ -95,7 +95,7 @@ languages.
                 "outputVar": "Hello ${ .firstname + \" \" +  .lastname  }"
             },
             "stateDataFilter": {
-                "dataOutputPath": "${ .outputVar }"
+                "output": "${ .outputVar }"
              },
             "end": true
         }
@@ -206,7 +206,7 @@ instance is created. See the Serverless Workflow ["Workflow Data"](../specificat
                 ]
             },
             "stateDataFilter": {
-                "dataOutputPath": "${ .array | join(\"\") }"
+                "output": "${ .array | join(\"\") }"
              },
             "end": true
         }

examples/README.md

@@ -166,7 +166,7 @@ Which is added to the states data and becomes the workflow data output.
               }
            },
            "actionDataFilter": {
-              "dataResultsPath": "${ .greeting }"
+              "results": "${ .greeting }"
            }
         }
      ],
@@ -197,7 +197,7 @@ states:
       arguments:
         name: "${ .person.name }"
     actionDataFilter:
-      dataResultsPath: "${ .greeting }"
+      results: "${ .greeting }"
   end: true
 ```
 
@@ -243,20 +243,20 @@ Note that in the workflow definition you can see two filters defined. The event
 ```json
 {
   "eventDataFilter": {
-    "dataOutputPath": "${ .data.greet } "
+    "data": "${ .data.greet } "
   }
 }
 ```
 
-which is triggered when the greeting event is consumed. It extracts its "data.greet" of the event and
-merges it with the states data.
+which is triggered when the greeting event is consumed. It extracts its "data.greet" of the event data (payload) and
+merges it with the state data.
 
 The second, a state data filter, which is defined on the event state itself:
 
 ```json
 {
   "stateDataFilter": {
-     "dataOutputPath": "${ .payload.greeting }"
+     "output": "${ .payload.greeting }"
   }
 }
 ```
@@ -310,7 +310,7 @@ filters what is selected to be the state data output which then becomes the work
      "onEvents": [{
          "eventRefs": ["GreetingEvent"],
          "eventDataFilter": {
-            "dataOutputPath": "${ .data.greet }"
+            "data": "${ .data.greet }"
          },
          "actions":[  
             {  
@@ -324,7 +324,7 @@ filters what is selected to be the state data output which then becomes the work
          ]
      }],
      "stateDataFilter": {
-        "dataOutputPath": "${ .payload.greeting }"
+        "output": "${ .payload.greeting }"
      },
      "end": true
   }
@@ -355,14 +355,14 @@ states:
   - eventRefs:
     - GreetingEvent
     eventDataFilter:
-      dataOutputPath: "${ .data.greet }"
+      data: "${ .data.greet }"
     actions:
     - functionRef:
         refName: greetingFunction
         arguments:
           name: "${ .greet.name }"
   stateDataFilter:
-    dataOutputPath: "${ .payload.greeting }"
+    output: "${ .payload.greeting }"
   end: true
 ```
 
@@ -438,7 +438,7 @@ result of the workflow execution.
    }
  ],
  "stateDataFilter": {
-    "dataOutputPath": "${ .results }"
+    "output": "${ .results }"
  },
  "end": true
 }
@@ -470,7 +470,7 @@ states:
       arguments:
         expression: "${ .singleexpression }"
   stateDataFilter:
-    dataOutputPath: "${ .results }"
+    output: "${ .results }"
   end: true
 ```
 
@@ -892,7 +892,7 @@ The data output of the workflow contains the information of the exception caught
        }
     ],
     "stateDataFilter": {
-       "dataOutputPath": "${ .exceptions }"
+       "output": "${ .exceptions }"
     },
     "transition": "ApplyOrder",
     "onErrors": [
@@ -960,7 +960,7 @@ states:
       arguments:
         order: "${ .order }"
   stateDataFilter:
-    dataOutputPath: "${ .exceptions }"
+    output: "${ .exceptions }"
   transition: ApplyOrder
   onErrors:
   - error: Missing order id
@@ -1060,7 +1060,7 @@ In the case job submission raises a runtime error, we transition to a SubFlow st
             }
           },
           "actionDataFilter": {
-            "dataResultsPath": "${ .jobuid }"
+            "results": "${ .jobuid }"
           }
       }
       ],
@@ -1071,7 +1071,7 @@ In the case job submission raises a runtime error, we transition to a SubFlow st
       }
       ],
       "stateDataFilter": {
-          "dataOutputPath": "${ .jobuid }"
+          "output": "${ .jobuid }"
       },
       "transition": "WaitForCompletion'"
   },
@@ -1100,12 +1100,12 @@ In the case job submission raises a runtime error, we transition to a SubFlow st
             }
           },
           "actionDataFilter": {
-          "dataResultsPath": "${ .jobstatus }"
+            "results": "${ .jobstatus }"
           }
       }
       ],
       "stateDataFilter": {
-          "dataOutputPath": "${ .jobstatus }"
+          "output": "${ .jobstatus }"
       },
       "transition": "DetermineCompletion"
   },
@@ -1190,12 +1190,12 @@ states:
       arguments:
         name: "${ .job.name }"
     actionDataFilter:
-      dataResultsPath: "${ .jobuid }"
+      results: "${ .jobuid }"
   onErrors:
   - error: "*"
     transition: SubmitError
   stateDataFilter:
-    dataOutputPath: "${ .jobuid }"
+    output: "${ .jobuid }"
   transition: WaitForCompletion
 - name: SubmitError
   type: subflow
@@ -1214,9 +1214,9 @@ states:
       arguments:
         name: "${ .jobuid }"
     actionDataFilter:
-      dataResultsPath: "${ .jobstatus }"
+      results: "${ .jobstatus }"
   stateDataFilter:
-    dataOutputPath: "${ .jobstatus }"
+    output: "${ .jobstatus }"
   transition: DetermineCompletion
 - name: DetermineCompletion
   type: switch
@@ -2358,7 +2358,7 @@ For this example we assume that the workflow instance is started given the follo
                        "resultEventRef":  "VetAppointmentInfo"
                     },
                     "actionDataFilter": {
-                        "dataResultsPath": "${ .appointmentInfo }"
+                        "results": "${ .appointmentInfo }"
                     },
                     "timeout": "PT15M"
                 }
@@ -2395,7 +2395,7 @@ states:
       data: "${ .patientInfo }"
       resultEventRef: VetAppointmentInfo
     actionDataFilter:
-      dataResultsPath: "${ .appointmentInfo }"
+      results: "${ .appointmentInfo }"
     timeout: PT15M
   end: true
 ```
@@ -3126,7 +3126,7 @@ the data for an hour, send report, and so on.
             }
           ],
           "eventDataFilter": {
-            "dataOutputPath": "${ .readings }"
+            "data": "${ .readings }"
           }
         }
       ],
@@ -3208,7 +3208,7 @@ states:
     - functionRef:
         refName: LogReading
     eventDataFilter:
-      dataOutputPath: "${ .readings }"
+      data: "${ .readings }"
   end: true
 - name: GenerateReport
   type: operation

media/spec/event-data-filter-example1.png

@@ -38,6 +38,7 @@ _Status description:_
 | ✔️| Replace JsonPath with jq | [spec doc](../specification.md) |
 | ✔️| Update start definition (move to top-level worklow param) | [spec doc](../specification.md) |
 | ✔️| Updated schedule definition | [spec doc](../specification.md) |
+| ✔️| Update data filters | [spec doc](../specification.md) |
 | 🚩 | Workflow invocation bindings |  |
 | 🚩 | CE Subscriptions & Discovery |  |
 | 🚩 | Error types | [issue](https://github.com/serverlessworkflow/specification/issues/200) |