Skip to content

Commit 151392d

Browse files
authored
Merge pull request serverlessworkflow#952 from matthias-pichler-warrify/runtime-arg
Specify runtime argument
2 parents 538a0a6 + 0ea6dcb commit 151392d

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

dsl.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,17 @@ When the evaluation of an expression fails, runtimes **must** raise an error wit
207207
| secrets | `map` | A key/value map of the workflow secrets.<br>To avoid unintentional bleeding, secrets can only be used in the `input.from` runtime expression. |
208208
| task | [`taskDescriptor`](#task-descriptor) | Describes the current task. |
209209
| workflow | [`workflowDescriptor`](#workflow-descriptor) | Describes the current workflow. |
210+
| runtime | [`runtimeDescriptor`](#runtime-descriptor) | Describes the runtime. |
211+
212+
##### Runtime Descriptor
213+
214+
This argument contains information about the runtime executing the workflow.
215+
216+
| Name | Type | Description | Example |
217+
|:-----|:----:|:------------| ------- |
218+
| name | `string` | A human friendly name for the runtime. | `Synapse`, `Sonata` |
219+
| version | `string` | The version of the runtime. This can be an arbitrary string | a incrementing positive integer (`362`), semantic version (`1.4.78`), commit hash (`04cd3be6da98fc35422c8caa821e0aa1ef6b2c02`) or container image label (`v0.7.43-alpine`) |
220+
| metadata | `map` | An object/map of implementation specific key-value pairs. This can be chosen by runtime implementors and usage of this argument signals that a given workflow definition might not be runtime agnostic | A Software as a Service (SaaS) provider might choose to expose information about the tenant the workflow is executed for e.g. `{ "organization": { "id": "org-ff51cff2-fc83-4d70-9af1-8dacdbbce0be", "name": "example-corp" }, "featureFlags": ["fastZip", "arm64"] }`. |
210221

211222
##### Task Descriptor
212223

@@ -221,7 +232,6 @@ When the evaluation of an expression fails, runtimes **must** raise an error wit
221232

222233
##### Workflow Descriptor
223234

224-
225235
| Name | Type | Description | Example |
226236
|:-----|:----:|:------------|:--------|
227237
| id | `string` | A unique id of the workflow execution. Now specific format is imposed | UUIDv4: `4a5c8422-5868-4e12-8dd9-220810d2b9ee`, ULID: `0000004JFGDSW1H037G7J7SFB9` |

0 commit comments

Comments
 (0)