Skip to content

Commit 5221ef3

Browse files
committed
Add the missing workflowDefinitionReference object
Signed-off-by: Charles d'Avernas <charles.davernas@neuroglia.io>
1 parent 6a102e3 commit 5221ef3

File tree

1 file changed

+26
-5
lines changed

1 file changed

+26
-5
lines changed

dsl-reference.md

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@
8080
+ [AsyncAPI Server](#asyncapi-server)
8181
+ [AsyncAPI Message](#asyncapi-message)
8282
+ [AsyncAPI Subscription](#asyncapi-subscription)
83+
+ [Workflow Definition Reference](#workflow-definition-reference)
8384

8485

8586
## Abstract
@@ -326,7 +327,7 @@ The [AsyncAPI Call](#asyncapi-call) enables workflows to interact with external
326327
###### Properties
327328

328329
| Name | Type | Required | Description |
329-
|:-------|:------:|:----------:|:--------------|
330+
|:-----|:----:|:--------:|:------------|
330331
| document | [`externalResource`](#external-resource) | `yes` | The AsyncAPI document that defines the [operation](https://www.asyncapi.com/docs/reference/specification/v3.0.0#operationObject) to call. |
331332
| channel | `string` | `yes` | The name of the channel on which to perform the operation. The operation to perform is defined by declaring either `message`, in which case the [channel](https://v2.asyncapi.com/docs/reference/specification/v2.6.0#channelItemObject)'s `publish` operation will be executed, or `subscription`, in which case the [channel](https://v2.asyncapi.com/docs/reference/specification/v2.6.0#channelItemObject)'s `subscribe` operation will be executed.<br>*Used only in case the referenced document uses AsyncAPI `v2.6.0`.* |
332333
| operation | `string` | `yes` | A reference to the AsyncAPI [operation](https://www.asyncapi.com/docs/reference/specification/v3.0.0#operationObject) to call.<br>*Used only in case the referenced document uses AsyncAPI `v3.0.0`.* |
@@ -2376,7 +2377,7 @@ Configures the target server of an AsyncAPI operation.
23762377
#### Properties
23772378

23782379
| Name | Type | Required | Description |
2379-
|:-------|:------:|:----------:|:--------------|
2380+
|:-----|:----:|:--------:|:------------|
23802381
| name | `string` | `yes` | The name of the [server](https://www.asyncapi.com/docs/reference/specification/v3.0.0#serverObject) to call the specified AsyncAPI operation on. |
23812382
| variables | `object` | `no` | The target [server's variables](https://www.asyncapi.com/docs/reference/specification/v3.0.0#serverVariableObject), if any. |
23822383

@@ -2414,7 +2415,7 @@ Configures an AsyncAPI message to publish.
24142415
#### Properties
24152416

24162417
| Name | Type | Required | Description |
2417-
|:-------|:------:|:----------:|:--------------|
2418+
|:-----|:----:|:--------:|:------------|
24182419
| payload | `object` | `no` | The message's payload, if any. |
24192420
| headers | `object` | `no` | The message's headers, if any. |
24202421

@@ -2449,7 +2450,7 @@ Configures a subscription to an AsyncAPI operation.
24492450
#### Properties
24502451

24512452
| Name | Type | Required | Description |
2452-
|:-------|:------:|:----------:|:--------------|
2453+
|:-----|:----:|:--------:|:------------|
24532454
| filter | `string` | `no` | A [runtime expression](dsl.md#runtime-expressions), if any, used to filter consumed messages. |
24542455
| consume | [`subscriptionLifetime`](#asyncapi-subscription-lifetime) | `yes` | An object used to configure the subscription's lifetime. |
24552456

@@ -2484,7 +2485,7 @@ Configures the lifetime of an AsyncAPI subscription
24842485
#### Properties
24852486

24862487
| Name | Type | Required | Description |
2487-
|:-------|:------:|:----------:|:--------------|
2488+
|:-----|:----:|:--------:|:------------|
24882489
| amount | `integer` | `no` | The amount of messages to consume.<br>*Required if `while` and `until` have not been set.* |
24892490
| for | [`duration`](#duration) | `no` | The [`duration`](#duration) that defines for how long to consume messages. |
24902491
| while | `string` | `no` | A [runtime expression](dsl.md#runtime-expressions), if any, used to determine whether or not to keep consuming messages.<br>*Required if `amount` and `until` have not been set.* |
@@ -2512,4 +2513,24 @@ do:
25122513
until: '${ ($context.messages | length) == 5 }'
25132514
for:
25142515
seconds: 10
2516+
```
2517+
2518+
### Workflow Definition Reference
2519+
2520+
References a workflow definition.
2521+
2522+
#### Properties
2523+
2524+
| Name | Type | Required | Description |
2525+
|:-----|:----:|:--------:|:------------|
2526+
| name | `string` | `yes` | The name of the referenced workflow definition. |
2527+
| namespace | `string` | `yes` | The namespace of the referenced workflow definition. |
2528+
| version | `string` | `yes` | The semantic version of the referenced workflow definition. |
2529+
2530+
#### Examples
2531+
2532+
```yaml
2533+
name: greet
2534+
namespace: samples
2535+
version: '0.1.0-rc2'
25152536
```

0 commit comments

Comments
 (0)