Skip to content

Commit 1648a76

Browse files
committed
fix(dsl-reference): correct table formatting
1 parent b3bb24a commit 1648a76

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

dsl-reference.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -96,16 +96,16 @@ A [workflow](#workflow) serves as a blueprint outlining the series of [tasks](#t
9696

9797
#### Properties
9898

99-
| Name | Type | Required | Description|
100-
|:--|:---------------------------------:|:---:|:---|
101-
| document | [`document`](#document) | `yes` | Documents the defined workflow. |
102-
| input | [`input`](#input) | `no` | Configures the workflow's input. |
103-
| use | [`use`](#use) | `no` | Defines the workflow's reusable components, if any. |
104-
| do | [`map[string, task`](#task) | `yes` | The [task(s)](#task) that must be performed by the [workflow](#workflow). |
99+
| Name | Type | Required | Description|
100+
|:--|:---:|:---:|:---|
101+
| document | [`document`](#document) | `yes` | Documents the defined workflow. |
102+
| input | [`input`](#input) | `no` | Configures the workflow's input. |
103+
| use | [`use`](#use) | `no` | Defines the workflow's reusable components, if any. |
104+
| do | [`map[string, task]`](#task) | `yes` | The [task(s)](#task) that must be performed by the [workflow](#workflow). |
105105
| timeout | `string`<br>[`timeout`](#timeout) | `no` | The configuration, if any, of the workflow's timeout.<br>*If a `string`, must be the name of a [timeout](#timeout) defined in the [workflow's reusable components](#use).* |
106-
| output | [`output`](#output) | `no` | Configures the workflow's output. |
107-
| schedule | [`schedule`](#schedule) | `no` | Configures the workflow's schedule, if any. |
108-
| evaluate | [`evaluate`](#evaluate) | `no` | Configures runtime expression evaluation. |
106+
| output | [`output`](#output) | `no` | Configures the workflow's output. |
107+
| schedule | [`schedule`](#schedule) | `no` | Configures the workflow's schedule, if any. |
108+
| evaluate | [`evaluate`](#evaluate) | `no` | Configures runtime expression evaluation. |
109109

110110
#### Document
111111

@@ -131,7 +131,7 @@ Defines the workflow's reusable components.
131131
| authentications | [`map[string, authentication]`](#authentication) | `no` | A name/value mapping of the workflow's reusable authentication policies. |
132132
| catalogs | [`map[string, catalog]`(#catalog)] | `no` | A name/value mapping of the workflow's reusable resource catalogs. |
133133
| errors | [`map[string, error]`](#error) | `no` | A name/value mapping of the workflow's reusable errors. |
134-
| extensions | [`map[string, extension][]`](#extension) | `no` | A list of the workflow's reusable extensions. |
134+
| extensions | [`map[string, extension]`](#extension) | `no` | A list of the workflow's reusable extensions. |
135135
| functions | [`map[string, task]`](#task) | `no` | A name/value mapping of the workflow's reusable tasks. |
136136
| retries | [`map[string, retryPolicy]`](#retry) | `no` | A name/value mapping of the workflow's reusable retry policies. |
137137
| secrets | `string[]` | `no` | A list containing the workflow's secrets. |
@@ -491,7 +491,7 @@ Serves as a fundamental building block within workflows, enabling the sequential
491491

492492
| Name | Type | Required | Description|
493493
|:--|:---:|:---:|:---|
494-
| do | [`map[string, task][]`](#task) | `no` | The tasks to perform sequentially. |
494+
| do | [`map[string, task]`](#task) | `no` | The tasks to perform sequentially. |
495495

496496
##### Examples
497497

@@ -588,12 +588,12 @@ Allows workflows to iterate over a collection of items, executing a defined set
588588

589589
##### Properties
590590

591-
| Name | Type | Required | Description|
592-
|:--|:----------------------------:|:---:|:---|
593-
| for.each | `string` | `no` | The name of the variable used to store the current item being enumerated.<br>Defaults to `item`. |
594-
| for.in | `string` | `yes` | A [runtime expression](dsl.md#runtime-expressions) used to get the collection to enumerate. |
595-
| for.at | `string` | `no` | The name of the variable used to store the index of the current item being enumerated.<br>Defaults to `index`. |
596-
| while | `string` | `no` | A [runtime expression](dsl.md#runtime-expressions) that represents the condition, if any, that must be met for the iteration to continue. |
591+
| Name | Type | Required | Description|
592+
|:--|:---:|:---:|:---|
593+
| for.each | `string` | `no` | The name of the variable used to store the current item being enumerated.<br>Defaults to `item`. |
594+
| for.in | `string` | `yes` | A [runtime expression](dsl.md#runtime-expressions) used to get the collection to enumerate. |
595+
| for.at | `string` | `no` | The name of the variable used to store the index of the current item being enumerated.<br>Defaults to `index`. |
596+
| while | `string` | `no` | A [runtime expression](dsl.md#runtime-expressions) that represents the condition, if any, that must be met for the iteration to continue. |
597597
| do | [`map[string, task]`](#task) | `yes` | The [task(s)](#task) to perform for each item in the collection. |
598598

599599
##### Examples
@@ -630,7 +630,7 @@ Allows workflows to execute multiple subtasks concurrently, enabling parallel pr
630630

631631
| Name | Type | Required | Description|
632632
|:--|:---:|:---:|:---|
633-
| fork.branches | [`map[string, task][]`](#task) | `no` | The tasks to perform concurrently. |
633+
| fork.branches | [`map[string, task]`](#task) | `no` | The tasks to perform concurrently. |
634634
| fork.compete | `boolean` | `no` | Indicates whether or not the concurrent [`tasks`](#task) are racing against each other, with a single possible winner, which sets the composite task's output.<br>*If set to `false`, the task returns an array that includes the outputs from each branch, preserving the order in which the branches are declared.*<br>*If to `true`, the task returns only the output of the winning branch.*<br>*Defaults to `false`.* |
635635

636636
##### Examples
@@ -1072,7 +1072,7 @@ Serves as a mechanism within workflows to handle errors gracefully, potentially
10721072

10731073
| Name | Type | Required | Description|
10741074
|:--|:---:|:---:|:---|
1075-
| try | [`map[string, task][]`](#task) | `yes` | The task(s) to perform. |
1075+
| try | [`map[string, task]`](#task) | `yes` | The task(s) to perform. |
10761076
| catch | [`catch`](#catch) | `yes` | Configures the errors to catch and how to handle them. |
10771077

10781078
##### Examples
@@ -1120,7 +1120,7 @@ Defines the configuration of a catch clause, which a concept used to catch error
11201120
| when | `string`| `no` | A runtime expression used to determine whether or not to catch the filtered error. |
11211121
| exceptWhen | `string` | `no` | A runtime expression used to determine whether or not to catch the filtered error. |
11221122
| retry | `string`<br>[`retryPolicy`](#retry) | `no` | The [`retry policy`](#retry) to use, if any, when catching [`errors`](#error).<br>*If a `string`, must be the name of a [retry policy](#retry) defined in the [workflow's reusable components](#use).* |
1123-
| do | [`map[string, task][]`](#task) | `no` | The definition of the task(s) to run when catching an error. |
1123+
| do | [`map[string, task]`](#task) | `no` | The definition of the task(s) to run when catching an error. |
11241124

11251125
#### Wait
11261126

@@ -1877,8 +1877,8 @@ Extensions enable the execution of tasks prior to those they extend, offering th
18771877
|----------|:----:|:--------:|-------------|
18781878
| extend | `string` | `yes` | The type of task to extend<br>Supported values are: `call`, `composite`, `emit`, `extension`, `for`, `listen`, `raise`, `run`, `set`, `switch`, `try`, `wait` and `all` |
18791879
| when | `string` | `no` | A runtime expression used to determine whether or not the extension should apply in the specified context |
1880-
| before | [`map[string, task][]`](#task) | `no` | The task to execute, if any, before the extended task |
1881-
| after | [`map[string, task][]`](#task) | `no` | The task to execute, if any, after the extended task |
1880+
| before | [`map[string, task]`](#task) | `no` | The task to execute, if any, before the extended task |
1881+
| after | [`map[string, task]`](#task) | `no` | The task to execute, if any, after the extended task |
18821882

18831883
#### Examples
18841884

@@ -2602,7 +2602,7 @@ Configures the iteration over each item (event or message) consumed by a subscri
26022602
|:-----|:----:|:--------:|:------------|
26032603
| item | `string` | `no` | The name of the variable used to store the current item being enumerated.<br>*Defaults to `item`.* |
26042604
| at | `string` | `no` | The name of the variable used to store the index of the current item being enumerated.<br>*Defaults to `index`.* |
2605-
| do | [`map[string, task][]`](#task) | `no` | The tasks to perform for each consumed item. |
2605+
| do | [`map[string, task]`](#task) | `no` | The tasks to perform for each consumed item. |
26062606
| output | [`output`](#output) | `no` | An object, if any, used to customize the item's output and to document its schema. |
26072607
| export | [`export`](#export) | `no` | An object, if any, used to customize the content of the workflow context. |
26082608

0 commit comments

Comments
 (0)