|
80 | 80 | + [AsyncAPI Server](#asyncapi-server)
|
81 | 81 | + [AsyncAPI Message](#asyncapi-message)
|
82 | 82 | + [AsyncAPI Subscription](#asyncapi-subscription)
|
| 83 | + + [Workflow Definition Reference](#workflow-definition-reference) |
83 | 84 |
|
84 | 85 |
|
85 | 86 | ## Abstract
|
@@ -326,7 +327,7 @@ The [AsyncAPI Call](#asyncapi-call) enables workflows to interact with external
|
326 | 327 | ###### Properties
|
327 | 328 |
|
328 | 329 | | Name | Type | Required | Description |
|
329 |
| -|:-------|:------:|:----------:|:--------------| |
| 330 | +|:-----|:----:|:--------:|:------------| |
330 | 331 | | 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. |
|
331 | 332 | | 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`.* |
|
332 | 333 | | 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.
|
2376 | 2377 | #### Properties
|
2377 | 2378 |
|
2378 | 2379 | | Name | Type | Required | Description |
|
2379 |
| -|:-------|:------:|:----------:|:--------------| |
| 2380 | +|:-----|:----:|:--------:|:------------| |
2380 | 2381 | | 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. |
|
2381 | 2382 | | variables | `object` | `no` | The target [server's variables](https://www.asyncapi.com/docs/reference/specification/v3.0.0#serverVariableObject), if any. |
|
2382 | 2383 |
|
@@ -2414,7 +2415,7 @@ Configures an AsyncAPI message to publish.
|
2414 | 2415 | #### Properties
|
2415 | 2416 |
|
2416 | 2417 | | Name | Type | Required | Description |
|
2417 |
| -|:-------|:------:|:----------:|:--------------| |
| 2418 | +|:-----|:----:|:--------:|:------------| |
2418 | 2419 | | payload | `object` | `no` | The message's payload, if any. |
|
2419 | 2420 | | headers | `object` | `no` | The message's headers, if any. |
|
2420 | 2421 |
|
@@ -2449,7 +2450,7 @@ Configures a subscription to an AsyncAPI operation.
|
2449 | 2450 | #### Properties
|
2450 | 2451 |
|
2451 | 2452 | | Name | Type | Required | Description |
|
2452 |
| -|:-------|:------:|:----------:|:--------------| |
| 2453 | +|:-----|:----:|:--------:|:------------| |
2453 | 2454 | | filter | `string` | `no` | A [runtime expression](dsl.md#runtime-expressions), if any, used to filter consumed messages. |
|
2454 | 2455 | | consume | [`subscriptionLifetime`](#asyncapi-subscription-lifetime) | `yes` | An object used to configure the subscription's lifetime. |
|
2455 | 2456 |
|
@@ -2484,7 +2485,7 @@ Configures the lifetime of an AsyncAPI subscription
|
2484 | 2485 | #### Properties
|
2485 | 2486 |
|
2486 | 2487 | | Name | Type | Required | Description |
|
2487 |
| -|:-------|:------:|:----------:|:--------------| |
| 2488 | +|:-----|:----:|:--------:|:------------| |
2488 | 2489 | | amount | `integer` | `no` | The amount of messages to consume.<br>*Required if `while` and `until` have not been set.* |
|
2489 | 2490 | | for | [`duration`](#duration) | `no` | The [`duration`](#duration) that defines for how long to consume messages. |
|
2490 | 2491 | | 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:
|
2512 | 2513 | until: '${ ($context.messages | length) == 5 }'
|
2513 | 2514 | for:
|
2514 | 2515 | 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' |
2515 | 2536 | ```
|
0 commit comments