Skip to content

Commit

Permalink
Merge pull request serverlessworkflow#996 from neuroglia-io/feat-add-…
Browse files Browse the repository at this point in the history
…metadata

Add a new `metadata` property to the workflow document and to tasks
  • Loading branch information
cdavernas authored Aug 30, 2024
2 parents 7539516 + ff2e7da commit be707ad
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
2 changes: 2 additions & 0 deletions dsl-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ Documents the workflow definition.
| title | `string` | `no` | The workflow's title. |
| summary | `string` | `no` | The workflow's Markdown summary. |
| tags | `map[string, string]` | `no` | A key/value mapping of the workflow's tags, if any. |
| metadata | `map` | `no` | Additional information about the workflow. |

#### Use

Expand Down Expand Up @@ -253,6 +254,7 @@ The Serverless Workflow DSL defines a list of [tasks](#task) that **must be** su
| export | [`export`](#export) | `no` | An object used to customize the content of the workflow context. |
| timeout | [`timeout`](#timeout) | `no` | The configuration of the task's timeout, if any. |
| then | [`flowDirective`](#flow-directive) | `no` | The flow directive to execute next.<br>*If not set, defaults to `continue`.* |
| metadata | `map` | `no` | Additional information about the task. |

#### Call

Expand Down
10 changes: 10 additions & 0 deletions schema/workflow.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,11 @@ properties:
title: WorkflowTags
description: A key/value mapping of the workflow's tags, if any.
additionalProperties: true
metadata:
type: object
title: WorkflowMetadata
description: Holds additional information about the workflow.
additionalProperties: true
required: [ dsl, namespace, name, version ]
input:
$ref: '#/$defs/input'
Expand Down Expand Up @@ -171,6 +176,11 @@ $defs:
$ref: '#/$defs/flowDirective'
title: TaskBaseThen
description: The flow directive to be performed upon completion of the task.
metadata:
type: object
title: TaskMetadata
description: Holds additional information about the task.
additionalProperties: true
task:
title: Task
description: A discrete unit of work that contributes to achieving the overall objectives defined by the workflow.
Expand Down

0 comments on commit be707ad

Please sign in to comment.