Skip to content

Commit

Permalink
mark review
Browse files Browse the repository at this point in the history
Signed-off-by: Hannah Hunter <[email protected]>
  • Loading branch information
hhunter-ms committed Jul 31, 2023
1 parent f19dfc9 commit 16beee2
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -59,14 +59,14 @@ Read the [Use output bindings to interface with external resources guide]({{< re

## Binding directions (optional)

You can provide information via the `direction` metadata field to indicate the direction supported by the binding component. With one of the following metadata values, the Dapr sidecar avoids the `"wait for the app to become ready"` state:
You can provide the `direction` metadata field to indicate the direction(s) supported by the binding component. In doing so, the Dapr sidecar avoids the `"wait for the app to become ready"` state reducing the lifecycle dependency between the Dapr sidecar and the application:

- `"input"`
- `"output"`
- `"input, output"`

{{% alert title="Note" color="primary" %}}
All bindings should include the `direction` property.
It is highly recommended that all bindings should include the `direction` property.
{{% /alert %}}

[See a full example of the bindings `direction` metadata.]({{< ref "bindings_api.md#binding-direction-optional" >}})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ spec:
- name: publishTopic
value: sample
- name: authRequired
value: "false"
value: false
- name: direction
value: output
```
Expand Down Expand Up @@ -93,7 +93,7 @@ spec:
- name: publishTopic
value: sample
- name: authRequired
value: "false"
value: false
- name: direction
value: output
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ spec:
- name: publishTopic
value: sample
- name: authRequired
value: "false"
value: false
- name: direction
value: input
```
Expand Down Expand Up @@ -98,7 +98,7 @@ spec:
- name: publishTopic
value: sample
- name: authRequired
value: "false"
value: false
- name: direction
value: input
```
Expand Down
4 changes: 2 additions & 2 deletions daprdocs/content/en/reference/api/bindings_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,15 +41,15 @@ If running on kubernetes apply the component to your cluster.

In some scenarios, it would be useful to provide additional information to Dapr to indicate the direction supported by the binding component.

Providing the supported binding direction helps the Dapr sidecar avoid the `"wait for the app to become ready"` state, where it waits indefinitely for the application to become available.
Providing the binding `direction` helps the Dapr sidecar avoid the `"wait for the app to become ready"` state, where it waits indefinitely for the application to become available. This decouples the lifecycle dependency between the Dapr sidecar and the application.

You can specify the `direction` field as part of the component's metadata. The valid values for this field are:
- `"input"`
- `"output"`
- `"input, output"`

{{% alert title="Note" color="primary" %}}
All bindings should include the `direction` property.
It is highly recommended that all bindings should include the `direction` property.
{{% /alert %}}

Here a few scenarios when the `"direction"` metadata field could help:
Expand Down

0 comments on commit 16beee2

Please sign in to comment.