You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Updated/fixed the dsl-reference.md file
- Ordered maintainers and code owners by alphabetic order
- Deleted the obsolete specification.md file
Signed-off-by: Charles d'Avernas <charles.davernas@neuroglia.io>
@@ -90,11 +89,11 @@ Defines the workflow's reusable components.
90
89
91
90
| Name | Type | Required | Description|
92
91
|:--|:---:|:---:|:---|
93
-
| authentications |[`map[string, authenticationPolicy]`](#authentication-policy)|`no`| A name/value mapping of the workflow's reusable authentication policies. |
92
+
| authentications |[`map[string, authentication]`](#authentication)|`no`| A name/value mapping of the workflow's reusable authentication policies. |
94
93
| errors |[`map[string, error]`](#error)|`no`| A name/value mapping of the workflow's reusable errors. |
95
94
| extensions |[`map[string, extension]`](#extension)|`no`| A name/value mapping of the workflow's reusable extensions. |
96
95
| 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. |
96
+
| retries |[`map[string, retryPolicy]`](#retry)|`no`| A name/value mapping of the workflow's reusable retry policies. |
98
97
| secrets |`string[]`|`no`| A list containing the workflow's secrets. |
99
98
100
99
#### Schedule
@@ -272,7 +271,7 @@ The [AsyncAPI Call](#asyncapi-call) enables workflows to interact with external
272
271
| message | `string` | `no` | The name of the message to use. <br>If not set, defaults to the first message defined by the operation. |
273
272
| binding | `string` | `no` | The name of the binding to use. <br>If not set, defaults to the first binding defined by the operation |
274
273
| payload | `any` | `no` | The operation's payload, as defined by the configured message |
275
-
| authentication | `string`<br>[`authenticationPolicy`](#authentication-policy) | `no` | The authentication policy, or the name of the authentication policy, to use when calling the AsyncAPI operation. |
274
+
| authentication | `string`<br>[`authentication`](#authentication) | `no` | The authentication policy, or the name of the authentication policy, to use when calling the AsyncAPI operation. |
276
275
277
276
###### Examples
278
277
@@ -307,7 +306,7 @@ The [gRPC Call](#grpc-call) enables communication with external systems via the
307
306
| service.name | `string` | `yes` | The name of the GRPC service to call. |
308
307
| service.host | `string` | `yes` | The hostname of the GRPC service to call. |
309
308
| service.port | `integer` | `no` | The port number of the GRPC service to call. |
310
-
| service.authentication | [`authenticationPolicy`](#authentication-policy) | `no` | The authentication policy, or the name of the authentication policy, to use when calling the GRPC service. |
309
+
| service.authentication | [`authentication`](#authentication) | `no` | The authentication policy, or the name of the authentication policy, to use when calling the GRPC service. |
311
310
| method | `string` | `yes` | The name of the GRPC service method to call. |
312
311
| arguments | `map` | `no` | A name/value mapping of the method call's arguments, if any. |
313
312
@@ -374,7 +373,7 @@ The [OpenAPI Call](#openapi-call) enables workflows to interact with external se
374
373
| document | [`externalResource`](#external-resource) | `yes` | The OpenAPI document that defines the operation to call. |
375
374
| operation | `string` | `yes` | The id of the OpenAPI operation to call. |
376
375
| arguments | `map` | `no` | A name/value mapping of the parameters, if any, of the OpenAPI operation to call. |
377
-
| authentication | [`authenticationPolicy`](#authentication-policy) | `no` | The authentication policy, or the name of the authentication policy, to use when calling the OpenAPI operation. |
376
+
| authentication | [`authentication`](#authentication) | `no` | The authentication policy, or the name of the authentication policy, to use when calling the OpenAPI operation. |
378
377
| 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`.* |
379
378
380
379
###### Examples
@@ -931,11 +930,11 @@ Defines the configuration of a catch clause, which a concept used to catch error
931
930
932
931
| Name | Type | Required | Description |
933
932
|:--|:---:|:---:|:---|
934
-
| errors | [`errorFilter`](#retry-policy) | `no` | The definition of the errors to catch |
933
+
| errors | [`errorFilter`](#retry) | `no` | The definition of the errors to catch |
935
934
| as | `string` | `no` | The name of the runtime expression variable to save the error as. Defaults to 'error'. |
936
935
| when | `string`| `no` | A runtime expression used to determine whether or not to catch the filtered error |
937
936
| exceptWhen | `string` | `no` | A runtime expression used to determine whether or not to catch the filtered error |
938
-
| retry | [`retryPolicy`](#retry-policy) | `no` | The retry policy to use, if any, when catching errors |
937
+
| retry | [`retryPolicy`](#retry) | `no` | The retry policy to use, if any, when catching errors |
939
938
| do | [`task`](#task) | `no` | The definition of the task to run when catching an error |
940
939
941
940
#### Wait
@@ -982,7 +981,7 @@ Defines an external resource.
982
981
|----------|:----:|:--------:|-------------|
983
982
| name | `string` | `no` | The name, if any, of the defined resource. |
984
983
| uri | `string` | `yes` | The URI at which to get the defined resource. |
985
-
| authentication | [`authenticationPolicy`](#authentication-policy) | `no` | The authentication policy, or the name of the authentication policy, to use when fecthing the resource. |
984
+
| authentication | [`authentication`](#authentication) | `no` | The authentication policy, or the name of the authentication policy, to use when fecthing the resource. |
986
985
987
986
##### Examples
988
987
@@ -995,9 +994,9 @@ authentication:
995
994
password: 1234
996
995
```
997
996
998
-
### Authentication Policy
997
+
### Authentication
999
998
1000
-
Defines the mechanism used to authenticate users and workflows attempting to access a service or a resource
999
+
Defines the mechanism used to authenticate users and workflows attempting to access a service or a resource.
1001
1000
1002
1001
#### Properties
1003
1002
@@ -1290,21 +1289,21 @@ Represents the configuration of an event consumption strategy.
1290
1289
| 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
1290
| 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
1291
1293
-
### Retry Policy
1292
+
### Retry
1294
1293
1295
-
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.
1294
+
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.
1296
1295
1297
1296
#### Properties
1298
1297
1299
1298
| Property | Type | Required | Description |
1300
1299
|----------|:----:|:--------:|-------------|
1301
1300
| when | `string` | `no` | A a runtime expression used to determine whether or not to retry running the task, in a given context. |
1302
1301
| exceptWhen | `string` | `no` | A runtime expression used to determine whether or not to retry running the task, in a given context. |
1303
-
| limit | [`retryPolicyLimit`](#retry-policy-limit) | `no` | The limits, if any, to impose to the retry policy. |
1304
-
| backoff | [`backoffStrategy`](#backoff-strategy) | `no` | The backoff strategy to use, if any. |
1302
+
| limit | [`retry`](#retry-limit) | `no` | The limits, if any, to impose to the retry policy. |
1303
+
| backoff | [`backoff`](#ackoff) | `no` | The backoff strategy to use, if any. |
1305
1304
| jitter | [`jitter`](#jitter) | `no` | The parameters, if any, that control the randomness or variability of the delay between retry attempts. |
1306
1305
1307
-
#### Retry Policy Limit
1306
+
#### Retry Limit
1308
1307
1309
1308
The definition of a retry policy.
1310
1309
@@ -1314,7 +1313,7 @@ The definition of a retry policy.
1314
1313
| attempt.duration | [`duration`](#duration) | `no` | The duration limit, if any, for all retry attempts. |
1315
1314
| duration | [`duration`](#duration) | `no` | The maximum duration, if any, during which to retry a given task. |
0 commit comments