Skip to content

Commit a946500

Browse files
committed
Minor fixes
Signed-off-by: Charles d'Avernas <[email protected]>
1 parent fe02547 commit a946500

File tree

3 files changed

+35
-10
lines changed

3 files changed

+35
-10
lines changed

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,6 @@ It encompasses a comprehensive suite of components and tools designed to facilit
6262

6363
5. **[Tooling](#tooling)**: Additional utilities and resources tailored to enhance the development, debugging, and management of serverless workflows, streamlining the workflow lifecycle from creation to deployment and maintenance.
6464

65-
6665
### SDKs
6766

6867
The Serverless Workflow SDKs are essential tools designed to assist developers in consuming, parsing, validating, and testing their workflows utilizing the Serverless Workflow DSL.

dsl-reference.md

Lines changed: 35 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55
- [Abstract](#abstract)
66
- [Definitions](#definitions)
77
+ [Workflow](#workflow)
8+
- [Document](#document)
9+
- [Use](#use)
10+
- [Schedule](#schedule)
811
+ [Task](#task)
912
- [Call](#call)
1013
+ [AsyncAPI](#asyncapi-call)
@@ -36,6 +39,7 @@
3639
+ [Extension](#extension)
3740
+ [Error](#error)
3841
+ [Error Filter](#error-filter)
42+
+ [Event Consumption Strategy](#event-consumption-strategy)
3943
+ [Retry Policy](#retry-policy)
4044
+ [Input](#input)
4145
+ [Output](#output)
@@ -59,11 +63,11 @@ A [workflow](#workflow) serves as a blueprint outlining the series of [tasks](#t
5963
| Name | Type | Required | Description|
6064
|:--|:---:|:---:|:---|
6165
| document | [`document`](#document) | `yes` | Documents the defined workflow. |
62-
| input | [`inputDataModel`](#input) | `no` | Configures the workflow's input. |
63-
| use | [`componentCollection`](#component-collection) | `no` | A collection containing the workflow's reusable components. |
66+
| input | [`input`](#input) | `no` | Configures the workflow's input. |
67+
| use | [`use`](#use) | `no` | Defines the workflow's reusable components, if any. |
6468
| do | [`map[string, task]`](#task) | `yes` | The [task(s)](#task) that must be performed by the [workflow](#workflow). |
6569
| timeout | [`timeout`](#timeout) | `no` | The configuration, if any, of the workflow's timeout. |
66-
| output | [`outputDataModel`](#output) | `no` | Configures the workflow's output. |
70+
| output | [`output`](#output) | `no` | Configures the workflow's output. |
6771
| schedule | [`schedule`](#schedule) | `no` | Configures the workflow's schedule, if any. |
6872

6973
#### Document
@@ -80,6 +84,19 @@ Documents the workflow definition.
8084
| summary | `string` | `no` | The workflow's Markdown summary. |
8185
| tags | `map[string, string]` | `no` | A key/value mapping of the workflow's tags, if any. |
8286

87+
#### Use
88+
89+
Defines the workflow's reusable components.
90+
91+
| Name | Type | Required | Description|
92+
|:--|:---:|:---:|:---|
93+
| authentications | [`map[string, authenticationPolicy]`](#authentication-policy) | `no` | A name/value mapping of the workflow's reusable authentication policies. |
94+
| errors | [`map[string, error]`](#error) | `no` | A name/value mapping of the workflow's reusable errors. |
95+
| extensions | [`map[string, extension]`](#extension) | `no` | A name/value mapping of the workflow's reusable extensions. |
96+
| functions | [`map[string, task]`](#task) | `no` | A name/value mapping of the workflow's reusable tasks. |
97+
| retries | [`map[string, retryPolicy]`](#retry-policy) | `no` | A name/value mapping of the workflow's reusable retry policies. |
98+
| secrets | `string[]` | `no` | A list containing the workflow's secrets. |
99+
83100
#### Schedule
84101

85102
Configures a workflow's schedule.
@@ -202,8 +219,8 @@ The Serverless Workflow DSL defines a list of [tasks](#task) that **must be** su
202219

203220
| Name | Type | Required | Description|
204221
|:--|:---:|:---:|:---|
205-
| input | [`inputDataModel`](#input) | `no` | An object used to customize the task's input and to document its schema, if any. |
206-
| output | [`outputDataModel`](#output) | `no` | An object used to customize the task's output and to document its schema, if any. |
222+
| input | [`input`](#input) | `no` | An object used to customize the task's input and to document its schema, if any. |
223+
| output | [`output`](#output) | `no` | An object used to customize the task's output and to document its schema, if any. |
207224
| timeout | [`timeout`](#timeout) | `no` | The configuration of the task's timeout, if any. |
208225
| then | [`flowDirective`](#flow-directive) | `no` | The flow directive to execute next.<br>*If not set, defaults to `continue`.* |
209226

@@ -550,9 +567,7 @@ Provides a mechanism for workflows to await and react to external events, enabli
550567

551568
| Name | Type | Required | Description|
552569
|:--|:---:|:---:|:---|
553-
| listen.to.all | [`eventFilter[]`](#event-filter) | `no` | Configures the workflow to wait for all defined events before resuming execution.<br>*Required if `any` and `one` have not been set.* |
554-
| listen.to.any | [`eventFilter[]`](#event-filter) | `no` | Configures the workflow to wait for any of the defined events before resuming execution.<br>*Required if `all` and `one` have not been set.* |
555-
| listen.to.one | [`eventFilter`](#event-filter) | `no` | Configures the workflow to wait for the defined event before resuming execution.<br>*Required if `all` and `any` have not been set.* |
570+
| listen.to | [`eventConsumptionStrategy`](#event-consumption-strategy) | `yes` | Configures the event(s) the workflow must listen to. |
556571

557572
##### Examples
558573

@@ -1263,6 +1278,18 @@ Standard error types serve the purpose of categorizing errors consistently acros
12631278

12641279
¹ *Default value. The `status code` that best describe the error should always be used.*
12651280

1281+
### Event Consumption Strategy
1282+
1283+
Represents the configuration of an event consumption strategy.
1284+
1285+
#### Properties
1286+
1287+
| Property | Type | Required | Description |
1288+
|----------|:----:|:--------:|-------------|
1289+
| all | [`eventFilter[]`](#event-filter) | `no` | Configures the workflow to wait for all defined events before resuming execution.<br>*Required if `any` and `one` have not been set.* |
1290+
| any | [`eventFilter[]`](#event-filter) | `no` | Configures the workflow to wait for any of the defined events before resuming execution.<br>*Required if `all` and `one` have not been set.* |
1291+
| one | [`eventFilter`](#event-filter) | `no` | Configures the workflow to wait for the defined event before resuming execution.<br>*Required if `all` and `any` have not been set.* |
1292+
12661293
### Retry Policy
12671294

12681295
The Retry Policy is a fundamental concept in the Serverless Workflow DSL, used to define the strategy for retrying a failed task when an error is encountered during execution. This policy provides developers with fine-grained control over how and when to retry failed tasks, enabling robust error handling and fault tolerance within workflows.

dsl.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,6 @@ Additionally, the flow of execution within a workflow can be controlled using [d
6161

6262
**To learn more about flow directives and how they can be utilized to control the execution and behavior of workflows, please refer to [Flow Directives](#flow-directives).*
6363

64-
6564
#TODO:
6665
+ Describe how workflow flows
6766
+ Explain how data flows

0 commit comments

Comments
 (0)