Skip to content
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

Jump to bottom

[Fix #3694] Updating documentation #671

Merged
merged 2 commits into from
Oct 16, 2024
Merged

[Fix #3694] Updating documentation #671

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
20ff7b2
[Fix #3694] Updating documentation
fjtirado Oct 4, 2024
fd0c267
Update serverlessworkflow/modules/ROOT/pages/core/understanding-jq-ex…
fjtirado Oct 9, 2024
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
53 changes: 53 additions & 0 deletions serverlessworkflow/modules/ROOT/pages/core/understanding-jq-expressions.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,6 +239,59 @@ In the previous example, a CloudEvent was published when the state transitioned.
data={"gitRepo":"ssh://bitbucket.org/m2k-test","branch":"aaaaaaasssss","token":null,"workspaceId":"b93980cb-3943-4223-9441-8694c098eeb9","projectId":"9b305fe3-d441-48ce-b01b-d314e86e14ec","transformId":"723dce89-c25c-4c7b-9ef3-842de92e6fe6","workflowCallerId":"7ddb5193-bedc-4942-a857-596b31f377ed"}
----

== ForEach state

ForEach `iteratiomParam` should be accessed as a variable, not as a JSON property, since the loop variable is not part of the workflow model the expression is evaluated against. This means that rather than prefixing the variable name with a `.`, it should be prefixed with a `$`
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure if it's needed to clarify that this applies to jq

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I do not think so, since the title mentions jq

fjtirado marked this conversation as resolved.
Show resolved Hide resolved

For instance, this link:{spec_doc_url}#foreach-state[ForEach specification example]

[source,json]
----
"states": [
{
"name":"SendConfirmState",
"type":"foreach",
"inputCollection": "${ [.orders[] | select(.completed == true)] }",
"iterationParam": "completedorder",
"outputCollection": "${ .confirmationresults }",
"actions":[
{
"functionRef": {
"refName": "sendConfirmationFunction",
"arguments": {
"orderNumber": "${ .completedorder.orderNumber }",
"email": "${ .completedorder.email }"
}
}
}],
"end": true
}]
----

should be modified to

----
"states": [
{
"name":"SendConfirmState",
"type":"foreach",
"inputCollection": "${ [.orders[] | select(.completed == true)] }",
"iterationParam": "completedorder",
"outputCollection": "${ .confirmationresults }",
"actions":[
{
"functionRef": {
"refName": "sendConfirmationFunction",
"arguments": {
"orderNumber": "${ $completedorder.orderNumber }",
"email": "${ $completedorder.email }"
}
}
}],
"end": true
}]
----


== Workflow secrets, constants and context

Expand Down