Skip to content

Commit 5a2acaf

Browse files
committed
- Generated the dsl.md file
- 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>
1 parent a946500 commit 5a2acaf

File tree

5 files changed

+441
-7005
lines changed

5 files changed

+441
-7005
lines changed

MAINTAINERS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Serverless Workflow Org Maintainers
22

3-
* [Tihomir Surdilovic](https://github.com/tsurdilo)
4-
* [Ricardo Zanini](https://github.com/ricardozanini)
5-
* [Charles d'Avernas](https://github.com/cdavernas)
63
* [Antonio Mendoza Pérez](https://github.com/antmendoza)
4+
* [Charles d'Avernas](https://github.com/cdavernas)
5+
* [Ricardo Zanini](https://github.com/ricardozanini)
6+
* [Tihomir Surdilovic](https://github.com/tsurdilo)
77

88
# Maintainers Mailing list
99
[cncf-serverlessws-maintainers](mailto:cncf-serverlessws-maintainers@lists.cncf.io)

dsl-reference.md

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -30,17 +30,16 @@
3030
- [Wait](#wait)
3131
+ [Flow Directive](#flow-directive)
3232
+ [External Resource](#external-resource)
33-
+ [Authentication Policy](#authentication-policy)
33+
+ [Authentication](#authentication)
3434
- [Basic](#basic-authentication)
3535
- [Bearer](#bearer-authentication)
3636
- [Certificate](#certificate-authentication)
3737
- [Digest](#digest-authentication)
3838
- [OAUTH2](#oauth2-authentication)
3939
+ [Extension](#extension)
4040
+ [Error](#error)
41-
+ [Error Filter](#error-filter)
4241
+ [Event Consumption Strategy](#event-consumption-strategy)
43-
+ [Retry Policy](#retry-policy)
42+
+ [Retry](#retry)
4443
+ [Input](#input)
4544
+ [Output](#output)
4645
+ [Timeout](#timeout)
@@ -90,11 +89,11 @@ Defines the workflow's reusable components.
9089

9190
| Name | Type | Required | Description|
9291
|:--|:---:|:---:|:---|
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. |
9493
| errors | [`map[string, error]`](#error) | `no` | A name/value mapping of the workflow's reusable errors. |
9594
| extensions | [`map[string, extension]`](#extension) | `no` | A name/value mapping of the workflow's reusable extensions. |
9695
| 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. |
9897
| secrets | `string[]` | `no` | A list containing the workflow's secrets. |
9998

10099
#### Schedule
@@ -272,7 +271,7 @@ The [AsyncAPI Call](#asyncapi-call) enables workflows to interact with external
272271
| message | `string` | `no` | The name of the message to use. <br>If not set, defaults to the first message defined by the operation. |
273272
| binding | `string` | `no` | The name of the binding to use. <br>If not set, defaults to the first binding defined by the operation |
274273
| 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. |
276275

277276
###### Examples
278277

@@ -307,7 +306,7 @@ The [gRPC Call](#grpc-call) enables communication with external systems via the
307306
| service.name | `string` | `yes` | The name of the GRPC service to call. |
308307
| service.host | `string` | `yes` | The hostname of the GRPC service to call. |
309308
| 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. |
311310
| method | `string` | `yes` | The name of the GRPC service method to call. |
312311
| arguments | `map` | `no` | A name/value mapping of the method call's arguments, if any. |
313312

@@ -374,7 +373,7 @@ The [OpenAPI Call](#openapi-call) enables workflows to interact with external se
374373
| document | [`externalResource`](#external-resource) | `yes` | The OpenAPI document that defines the operation to call. |
375374
| operation | `string` | `yes` | The id of the OpenAPI operation to call. |
376375
| 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. |
378377
| 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`.* |
379378

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

932931
| Name | Type | Required | Description |
933932
|:--|:---:|:---:|:---|
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 |
935934
| as | `string` | `no` | The name of the runtime expression variable to save the error as. Defaults to 'error'. |
936935
| when | `string`| `no` | A runtime expression used to determine whether or not to catch the filtered error |
937936
| 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 |
939938
| do | [`task`](#task) | `no` | The definition of the task to run when catching an error |
940939

941940
#### Wait
@@ -982,7 +981,7 @@ Defines an external resource.
982981
|----------|:----:|:--------:|-------------|
983982
| name | `string` | `no` | The name, if any, of the defined resource. |
984983
| 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. |
986985

987986
##### Examples
988987

@@ -995,9 +994,9 @@ authentication:
995994
password: 1234
996995
```
997996

998-
### Authentication Policy
997+
### Authentication
999998

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.
10011000

10021001
#### Properties
10031002

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

1293-
### Retry Policy
1292+
### Retry
12941293

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.
12961295

12971296
#### Properties
12981297

12991298
| Property | Type | Required | Description |
13001299
|----------|:----:|:--------:|-------------|
13011300
| when | `string` | `no` | A a runtime expression used to determine whether or not to retry running the task, in a given context. |
13021301
| 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. |
13051304
| jitter | [`jitter`](#jitter) | `no` | The parameters, if any, that control the randomness or variability of the delay between retry attempts. |
13061305

1307-
#### Retry Policy Limit
1306+
#### Retry Limit
13081307

13091308
The definition of a retry policy.
13101309

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

1317-
#### Backoff Strategy
1316+
#### Backoff
13181317

13191318
The definition of a retry backoff strategy.
13201319

0 commit comments

Comments
 (0)