From 646016926332cd205aa08784de835d6bfc858fa6 Mon Sep 17 00:00:00 2001 From: Guillermo Caracuel <633810+gcaracuel@users.noreply.github.com> Date: Sat, 2 Dec 2023 06:53:04 +0100 Subject: [PATCH] Fix Subscription docs to match Kubernetes CRDs (#3888) Signed-off-by: gcaracuel <633810+gcaracuel@users.noreply.github.com> --- .../resource-specs/subscription-schema.md | 24 +++++++++---------- 1 file changed, 11 insertions(+), 13 deletions(-) diff --git a/daprdocs/content/en/reference/resource-specs/subscription-schema.md b/daprdocs/content/en/reference/resource-specs/subscription-schema.md index 55b8bc76f5f..bd5fc8263a8 100644 --- a/daprdocs/content/en/reference/resource-specs/subscription-schema.md +++ b/daprdocs/content/en/reference/resource-specs/subscription-schema.md @@ -21,18 +21,17 @@ kind: Subscription metadata: name: spec: - version: v2alpha1 topic: # Required routes: # Required - rules: - - match: + - match: path: pubsubname: # Required - deadlettertopic: # Optional - bulksubscribe: # Optional - - enabled: - - maxmessages: - - maxawaitduration: + deadLetterTopic: # Optional + bulkSubscribe: # Optional + - enabled: + - maxMessagesCount: + - maxAwaitDurationMs: scopes: - ``` @@ -42,10 +41,10 @@ scopes: | Field | Required | Details | Example | |--------------------|:--------:|---------|---------| | 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:
  • match: _Optional._ The CEL expression used to match the event. If not specified, the route is considered the default.
  • path: The path for events that match this rule.
The endpoint to which all topic messages are sent. | `match: event.type == "widget"`
`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:
  • match: The CEL expression used to match the event. If not specified, the route is considered the default.
  • path: The path for events that match this rule.
The endpoint to which all topic messages are sent. | `match: event.type == "widget"`
`path: /widgets` | | pubsubname | N | The name of your pub/sub component. | `pubsub` | -| deadlettertopic | N | The name of the dead letter topic that forwards undeliverable messages. | `poisonMessages` | -| bulksubscribe | N | Enable bulk subscribe properties. | `true`, `false` | +| deadLetterTopic | N | The name of the dead letter topic that forwards undeliverable messages. | `poisonMessages` | +| bulkSubscribe | N | Enable bulk subscribe properties. | `true`, `false` | ## `v1alpha1` format @@ -58,15 +57,14 @@ kind: Subscription metadata: name: spec: - version: v1alpha1 topic: # Required route: # Required pubsubname: # Required deadLetterTopic: # Optional bulkSubscribe: # Optional - enabled: - - maxmessages: - - maxawaitduration: + - maxMessagesCount: + - maxAwaitDurationMs: scopes: - ```