Skip to content

Document content of $workflow and $task arguments #951

Closed
@matthias-pichler

Description

@matthias-pichler

What would you like to be added:

The $workflow and $task arguments are mentioned in the DSL but their contents are never specified. We should clarify this:

$workflow

  • $workflow.definition ... the workflow definition as a parsed object
  • $workflow.input ... the input of the workflow BEFORE the input.from expression was applied. For the result of the input.from expression use the $input argument
  • $workflow.startedAt... an object with the properties iso8601, epochMillis and epochNanos to represent the execution start time
  • $workflow.id ... the unique id of the execution

$task

  • $task.definition ... the task definition (object under the name) as a parsed object
  • $task.input ... the input of the workflow BEFORE the input.from expression was applied. For the result of the input.from expression use the context . of the expression
  • $task.startedAt... an object with the properties iso8601, epochMillis and epochNanos to represent the task start time
  • $task.name ... the unique name of the task

Why is this needed:

Open Questions:

Should the .input properties be the result of the input.from expression or the raw input to avoid duplication?

Metadata

Metadata

Assignees

No one assigned

    Labels

    area: specChanges in the Specificationchange: documentationImprovements or additions to documentation. It won't impact a version change.change: fixSomething isn't working. Impacts in a minor version change.

    Type

    No type

    Projects

    Status

    Done

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions