dapr
/
docs
mirror of https://github.com/dapr/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'v1.12' into update-multi-app-run-steps

This commit is contained in:
Yaron Schneider 2023-12-06 18:07:59 -08:00 committed by GitHub
parent b989988e38 6460169263
commit 276cc169ce
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
daprdocs/content/en/reference/resource-specs/subscription-schema.md
View File

@ -21,18 +21,17 @@ kind: Subscription
metadata: metadata:
name: <REPLACE-WITH-NAME> name: <REPLACE-WITH-NAME>
spec: spec:
version: v2alpha1
topic: <REPLACE-WITH-TOPIC-NAME> # Required topic: <REPLACE-WITH-TOPIC-NAME> # Required
routes: # Required routes: # Required
- rules: - rules:
- match: <REPLACE-WITH-EVENT-TYPE> - match: <REPLACE-WITH-CEL-FILTER>
path: <REPLACE-WITH-PATH> path: <REPLACE-WITH-PATH>
pubsubname: <REPLACE-WITH-PUBSUB-NAME> # Required pubsubname: <REPLACE-WITH-PUBSUB-NAME> # Required
deadlettertopic: <REPLACE-WITH-TOPIC-NAME> # Optional deadLetterTopic: <REPLACE-WITH-DEADLETTERTOPIC-NAME> # Optional
bulksubscribe: # Optional bulkSubscribe: # Optional
- enabled: <REPLACE-WITH-TOPIC-NAME> - enabled: <REPLACE-WITH-BOOLEAN-VALUE>
- maxmessages: <REPLACE-WITH-TOPIC-NAME> - maxMessagesCount: <REPLACE-WITH-VALUE>
- maxawaitduration: <REPLACE-WITH-TOPIC-NAME> - maxAwaitDurationMs: <REPLACE-WITH-VALUE>
scopes: scopes:
- <REPLACE-WITH-SCOPED-APPIDS> - <REPLACE-WITH-SCOPED-APPIDS>
``` ```
@ -42,10 +41,10 @@ scopes:
| Field | Required | Details | Example | | Field | Required | Details | Example |
|--------------------|:--------:|---------|---------| |--------------------|:--------:|---------|---------|
| topic | Y | The name of the topic to which your component subscribes. | `orders` | | topic | Y | The name of the topic to which your component subscribes. | `orders` |
| routes | Y | The routes configuration for this topic, including specifying the condition for sending a message to a specific path. Includes the following fields: <br><ul><li>match: _Optional._ The CEL expression used to match the event. If not specified, the route is considered the default. </li><li>path: The path for events that match this rule. </li></ul>The endpoint to which all topic messages are sent. | `match: event.type == "widget"` <br>`path: /widgets` | | routes | Y | The routes configuration for this topic, including specifying the condition for sending a message to a specific path. Includes the following fields: <br><ul><li>match: The CEL expression used to match the event. If not specified, the route is considered the default. </li><li>path: The path for events that match this rule. </li></ul>The endpoint to which all topic messages are sent. | `match: event.type == "widget"` <br>`path: /widgets` |
| pubsubname | N | The name of your pub/sub component. | `pubsub` | | pubsubname | N | The name of your pub/sub component. | `pubsub` |
| deadlettertopic | N | The name of the dead letter topic that forwards undeliverable messages. | `poisonMessages` | | deadLetterTopic | N | The name of the dead letter topic that forwards undeliverable messages. | `poisonMessages` |
| bulksubscribe | N | Enable bulk subscribe properties. | `true`, `false` | | bulkSubscribe | N | Enable bulk subscribe properties. | `true`, `false` |
## `v1alpha1` format ## `v1alpha1` format
@ -58,15 +57,14 @@ kind: Subscription
metadata: metadata:
name: <REPLACE-WITH-RESOURCE-NAME> name: <REPLACE-WITH-RESOURCE-NAME>
spec: spec:
version: v1alpha1
topic: <REPLACE-WITH-TOPIC-NAME> # Required topic: <REPLACE-WITH-TOPIC-NAME> # Required
route: <REPLACE-WITH-ROUTE-NAME> # Required route: <REPLACE-WITH-ROUTE-NAME> # Required
pubsubname: <REPLACE-WITH-PUBSUB-NAME> # Required pubsubname: <REPLACE-WITH-PUBSUB-NAME> # Required
deadLetterTopic: <REPLACE-WITH-DEAD-LETTER-TOPIC-NAME> # Optional deadLetterTopic: <REPLACE-WITH-DEAD-LETTER-TOPIC-NAME> # Optional
bulkSubscribe: # Optional bulkSubscribe: # Optional
- enabled: <REPLACE-WITH-BOOLEAN-VALUE> - enabled: <REPLACE-WITH-BOOLEAN-VALUE>
- maxmessages: <REPLACE-WITH-VALUE> - maxMessagesCount: <REPLACE-WITH-VALUE>
- maxawaitduration: <REPLACE-WITH-VALUE> - maxAwaitDurationMs: <REPLACE-WITH-VALUE>
scopes: scopes:
- <REPLACE-WITH-SCOPED-APPIDS> - <REPLACE-WITH-SCOPED-APPIDS>
``` ```