Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

1.0.0-alpha1 #847

Merged
merged 10 commits into from
May 22, 2024
Merged

1.0.0-alpha1 #847

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
0b459f6
Initial commit (rebase)
cdavernas May 21, 2024
3dcdcd8
Updated/fixed the DSL schema
cdavernas May 21, 2024
4f17742
Added the `schedule` top level property to the workflow
cdavernas May 21, 2024
fe02547
Lowercases all workflow status phases, and renamed `suspended` by `wa…
cdavernas May 21, 2024
a946500
Minor fixes
cdavernas May 21, 2024
5a2acaf
- Generated the dsl.md file
cdavernas May 22, 2024
c2366b2
Added the top level `evaluate` property, used to configure both the r…
cdavernas May 22, 2024
1d73ede
Addresses the Ricardo's comment about a missing anchor for 'secret'
cdavernas May 22, 2024
a80c808
Added an example and fixed both schema and dsl
cdavernas May 22, 2024
ea330b3
Added missing event filter and correlation definitions in both dsl-re…
cdavernas May 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions MAINTAINERS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Serverless Workflow Org Maintainers

* [Tihomir Surdilovic](https://github.com/tsurdilo)
* [Ricardo Zanini](https://github.com/ricardozanini)
* [Charles d'Avernas](https://github.com/cdavernas)
* [Antonio Mendoza Pérez](https://github.com/antmendoza)
* [Charles d'Avernas](https://github.com/cdavernas)
* [Ricardo Zanini](https://github.com/ricardozanini)
* [Tihomir Surdilovic](https://github.com/tsurdilo)

# Maintainers Mailing list
[cncf-serverlessws-maintainers](mailto:[email protected])
37 changes: 18 additions & 19 deletions dsl-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,17 +30,16 @@
- [Wait](#wait)
+ [Flow Directive](#flow-directive)
+ [External Resource](#external-resource)
+ [Authentication Policy](#authentication-policy)
+ [Authentication](#authentication)
- [Basic](#basic-authentication)
- [Bearer](#bearer-authentication)
- [Certificate](#certificate-authentication)
- [Digest](#digest-authentication)
- [OAUTH2](#oauth2-authentication)
+ [Extension](#extension)
+ [Error](#error)
+ [Error Filter](#error-filter)
+ [Event Consumption Strategy](#event-consumption-strategy)
+ [Retry Policy](#retry-policy)
+ [Retry](#retry)
+ [Input](#input)
+ [Output](#output)
+ [Timeout](#timeout)
Expand Down Expand Up @@ -90,11 +89,11 @@ Defines the workflow's reusable components.

| Name | Type | Required | Description|
|:--|:---:|:---:|:---|
| authentications | [`map[string, authenticationPolicy]`](#authentication-policy) | `no` | A name/value mapping of the workflow's reusable authentication policies. |
| authentications | [`map[string, authentication]`](#authentication) | `no` | A name/value mapping of the workflow's reusable authentication policies. |
| errors | [`map[string, error]`](#error) | `no` | A name/value mapping of the workflow's reusable errors. |
| extensions | [`map[string, extension]`](#extension) | `no` | A name/value mapping of the workflow's reusable extensions. |
| functions | [`map[string, task]`](#task) | `no` | A name/value mapping of the workflow's reusable tasks. |
| retries | [`map[string, retryPolicy]`](#retry-policy) | `no` | A name/value mapping of the workflow's reusable retry policies. |
| retries | [`map[string, retryPolicy]`](#retry) | `no` | A name/value mapping of the workflow's reusable retry policies. |
| secrets | `string[]` | `no` | A list containing the workflow's secrets. |

#### Schedule
Expand Down Expand Up @@ -272,7 +271,7 @@ The [AsyncAPI Call](#asyncapi-call) enables workflows to interact with external
| message | `string` | `no` | The name of the message to use. <br>If not set, defaults to the first message defined by the operation. |
| binding | `string` | `no` | The name of the binding to use. <br>If not set, defaults to the first binding defined by the operation |
| payload | `any` | `no` | The operation's payload, as defined by the configured message |
| authentication | `string`<br>[`authenticationPolicy`](#authentication-policy) | `no` | The authentication policy, or the name of the authentication policy, to use when calling the AsyncAPI operation. |
| authentication | `string`<br>[`authentication`](#authentication) | `no` | The authentication policy, or the name of the authentication policy, to use when calling the AsyncAPI operation. |

###### Examples

Expand Down Expand Up @@ -307,7 +306,7 @@ The [gRPC Call](#grpc-call) enables communication with external systems via the
| service.name | `string` | `yes` | The name of the GRPC service to call. |
| service.host | `string` | `yes` | The hostname of the GRPC service to call. |
| service.port | `integer` | `no` | The port number of the GRPC service to call. |
| service.authentication | [`authenticationPolicy`](#authentication-policy) | `no` | The authentication policy, or the name of the authentication policy, to use when calling the GRPC service. |
| service.authentication | [`authentication`](#authentication) | `no` | The authentication policy, or the name of the authentication policy, to use when calling the GRPC service. |
| method | `string` | `yes` | The name of the GRPC service method to call. |
| arguments | `map` | `no` | A name/value mapping of the method call's arguments, if any. |

Expand Down Expand Up @@ -374,7 +373,7 @@ The [OpenAPI Call](#openapi-call) enables workflows to interact with external se
| document | [`externalResource`](#external-resource) | `yes` | The OpenAPI document that defines the operation to call. |
| operation | `string` | `yes` | The id of the OpenAPI operation to call. |
| arguments | `map` | `no` | A name/value mapping of the parameters, if any, of the OpenAPI operation to call. |
| authentication | [`authenticationPolicy`](#authentication-policy) | `no` | The authentication policy, or the name of the authentication policy, to use when calling the OpenAPI operation. |
| authentication | [`authentication`](#authentication) | `no` | The authentication policy, or the name of the authentication policy, to use when calling the OpenAPI operation. |
| output | `string` | `no` | The OpenAPI call's output format.<br>*Supported values are:*<br>*- `raw`, which output's the base-64 encoded [http response](#http-response) content, if any.*<br>*- `content`, which outputs the content of [http response](#http-response), possibly deserialized.*<br>*- `response`, which outputs the [http response](#http-response).*<br>*Defaults to `content`.* |

###### Examples
Expand Down Expand Up @@ -931,11 +930,11 @@ Defines the configuration of a catch clause, which a concept used to catch error

| Name | Type | Required | Description |
|:--|:---:|:---:|:---|
| errors | [`errorFilter`](#retry-policy) | `no` | The definition of the errors to catch |
| errors | [`errorFilter`](#retry) | `no` | The definition of the errors to catch |
| as | `string` | `no` | The name of the runtime expression variable to save the error as. Defaults to 'error'. |
| when | `string`| `no` | A runtime expression used to determine whether or not to catch the filtered error |
| exceptWhen | `string` | `no` | A runtime expression used to determine whether or not to catch the filtered error |
| retry | [`retryPolicy`](#retry-policy) | `no` | The retry policy to use, if any, when catching errors |
| retry | [`retryPolicy`](#retry) | `no` | The retry policy to use, if any, when catching errors |
| do | [`task`](#task) | `no` | The definition of the task to run when catching an error |

#### Wait
Expand Down Expand Up @@ -982,7 +981,7 @@ Defines an external resource.
|----------|:----:|:--------:|-------------|
| name | `string` | `no` | The name, if any, of the defined resource. |
| uri | `string` | `yes` | The URI at which to get the defined resource. |
| authentication | [`authenticationPolicy`](#authentication-policy) | `no` | The authentication policy, or the name of the authentication policy, to use when fecthing the resource. |
| authentication | [`authentication`](#authentication) | `no` | The authentication policy, or the name of the authentication policy, to use when fecthing the resource. |

##### Examples

Expand All @@ -995,9 +994,9 @@ authentication:
password: 1234
```

### Authentication Policy
### Authentication

Defines the mechanism used to authenticate users and workflows attempting to access a service or a resource
Defines the mechanism used to authenticate users and workflows attempting to access a service or a resource.

#### Properties

Expand Down Expand Up @@ -1290,21 +1289,21 @@ Represents the configuration of an event consumption strategy.
| 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.* |
| 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.* |

### Retry Policy
### Retry

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.
The Retry 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.

#### Properties

| Property | Type | Required | Description |
|----------|:----:|:--------:|-------------|
| when | `string` | `no` | A a runtime expression used to determine whether or not to retry running the task, in a given context. |
| exceptWhen | `string` | `no` | A runtime expression used to determine whether or not to retry running the task, in a given context. |
| limit | [`retryPolicyLimit`](#retry-policy-limit) | `no` | The limits, if any, to impose to the retry policy. |
| backoff | [`backoffStrategy`](#backoff-strategy) | `no` | The backoff strategy to use, if any. |
| limit | [`retry`](#retry-limit) | `no` | The limits, if any, to impose to the retry policy. |
| backoff | [`backoff`](#ackoff) | `no` | The backoff strategy to use, if any. |
| jitter | [`jitter`](#jitter) | `no` | The parameters, if any, that control the randomness or variability of the delay between retry attempts. |

#### Retry Policy Limit
#### Retry Limit

The definition of a retry policy.

Expand All @@ -1314,7 +1313,7 @@ The definition of a retry policy.
| attempt.duration | [`duration`](#duration) | `no` | The duration limit, if any, for all retry attempts. |
| duration | [`duration`](#duration) | `no` | The maximum duration, if any, during which to retry a given task. |

#### Backoff Strategy
#### Backoff

The definition of a retry backoff strategy.

Expand Down
Loading
Loading