docs(pulsar): add CloudEvents schema wrapping, rawschema option, and processMode improvements by javier-aliaga · Pull Request #5084 · dapr/docs

javier-aliaga · 2026-03-24T15:22:40Z

Details

CloudEvents schema wrapping & rawschema flag: Document how Dapr wraps Avro/JSON schemas in a CloudEvents envelope before registering with the Pulsar Schema Registry. Add the new <topic-name>.rawschema
metadata field for topics that exclusively receive raw payloads. Includes a behavior matrix table, usage warnings, and a multi-topic YAML example showing CE-wrapped and raw-payload topics side by side.
processMode as component-level metadata: Clarify that processMode (sync/async) can now be set at the component level and overridden per subscription via request metadata. Previously it was silently
ignored when set in the component YAML. (Ref: fix(pubsub/pulsar): read processMode from component metadata and add async backpressure components-contrib#4309)
maxConcurrentHandlers backpressure: Document the fixed worker pool behavior in async mode and the fallback to the default (100) when set to 0. (Ref: fix(pubsub/pulsar): read processMode from component metadata and add async backpressure components-contrib#4309)
Misc: Add processMode and maxConcurrentHandlers to the example YAML.

Thank you for helping make the Dapr documentation better!

Please follow this checklist before submitting:

Commits are signed with Developer Certificate of Origin (DCO - learn more)
Read the contribution guide
Commands include options for Linux, MacOS, and Windows within tabpane
New file and folder names are globally unique
Page references use shortcodes instead of markdown or URL links
Images use HTML style and have alternative text
Places where multiple code/command options are given have tabpane

In addition, please fill out the following to help reviewers understand this pull request:

Description

Issue reference

Copilot

Pull request overview

Updates the Pulsar pub/sub component documentation to explain Avro schema registration behavior when publishing CloudEvents, and introduces a component-level option to register the “inner” Avro schema for raw-payload-only topics.

Changes:

Document that <topic-name>.avroschema is wrapped in a CloudEvents Avro envelope schema when CloudEvents wrapping is enabled (default).
Add <topic-name>.rawSchema metadata to register the inner Avro schema directly (for raw-payload-only topics).
Add a behavior matrix and example configuration for splitting CE-wrapped vs raw-payload topics.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 3 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

alicejgibbons

a few things

Document the new behavior where Dapr wraps user-provided Avro schemas inside a CloudEvents envelope before registering with the Pulsar Schema Registry. Add the new `<topic-name>.rawPayload` metadata field for topics that need to skip CE wrapping and register the inner schema directly. Ref: dapr/components-contrib#4302 Signed-off-by: Javier Aliaga <javier@diagrid.io>

…nc backpressure processMode can now be set at the component level (not just subscription request metadata) and overridden per subscription. Updated description for maxConcurrentHandlers to document the fixed worker pool with backpressure and the fallback behavior when set to 0. Ref: dapr/components-contrib#4309 Signed-off-by: Javier Aliaga <javier@diagrid.io>

Co-authored-by: Alice Gibbons <alicejgibbons@gmail.com> Signed-off-by: Javier Aliaga <javier@diagrid.io>

msfussell

LGTM

* Promote 1.17 to latest Signed-off-by: Marc Duiker <marcduiker@users.noreply.github.com> * Adding support to configure gRPC message limits in workflows in .NET Signed-off-by: Whit Waldo <whit.waldo@innovian.net> * Fix CLI example for workflow versioning. Signed-off-by: joshvanl <me@joshvanl.dev> * Apply suggestions from code review Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Mark Fussell <markfussell@gmail.com> * Updates resiliency of streaming HTTP Service Invocation Based on this PR dapr/dapr#9627 Signed-off-by: joshvanl <me@joshvanl.dev> * workflow: retention policy is not retroactive Clarify that adding or changing a retention policy does not retroactively purge workflows already in a terminal state. Include CLI examples for retroactive cleanup using `dapr workflow purge --all-older-than` and `dapr workflow list --filter-status` combined with purge. Signed-off-by: joshvanl <me@joshvanl.dev> * Workflow: `wf purge --all-older-than --all-filter-status` Update docs based on new CLI flag dapr/cli#1609 Signed-off-by: joshvanl <me@joshvanl.dev> * Update docs for v1.17.2 (#5081) Signed-off-by: joshvanl <me@joshvanl.dev> * docs(agents): update with v1.0 rcs out (#5071) * docs(agents): update with v1.0 rcs out Signed-off-by: Samantha Coyle <sam@diagrid.io> * fix: address copilot feedback Signed-off-by: Samantha Coyle <sam@diagrid.io> * Update daprdocs/content/en/developing-ai/dapr-agents/dapr-agents-core-concepts.md Co-authored-by: Alice Gibbons <alicejgibbons@gmail.com> Signed-off-by: Sam <sam@diagrid.io> * Update daprdocs/content/en/developing-ai/dapr-agents/dapr-agents-core-concepts.md Co-authored-by: Alice Gibbons <alicejgibbons@gmail.com> Signed-off-by: Sam <sam@diagrid.io> * Update daprdocs/content/en/developing-ai/dapr-agents/dapr-agents-core-concepts.md Co-authored-by: Alice Gibbons <alicejgibbons@gmail.com> Signed-off-by: Sam <sam@diagrid.io> * Update daprdocs/content/en/developing-ai/dapr-agents/dapr-agents-integrations.md Co-authored-by: Alice Gibbons <alicejgibbons@gmail.com> Signed-off-by: Sam <sam@diagrid.io> * Update daprdocs/content/en/developing-ai/dapr-agents/dapr-agents-core-concepts.md Co-authored-by: Alice Gibbons <alicejgibbons@gmail.com> Signed-off-by: Sam <sam@diagrid.io> * Update daprdocs/content/en/developing-ai/dapr-agents/dapr-agents-core-concepts.md Co-authored-by: Alice Gibbons <alicejgibbons@gmail.com> Signed-off-by: Sam <sam@diagrid.io> --------- Signed-off-by: Samantha Coyle <sam@diagrid.io> Signed-off-by: Sam <sam@diagrid.io> Co-authored-by: Alice Gibbons <alicejgibbons@gmail.com> Co-authored-by: Yaron Schneider <schneider.yaron@live.com> * docs(pulsar): add CloudEvents schema wrapping, rawschema option, and processMode improvements (#5084) * docs(pulsar): add CloudEvents Avro schema wrapping and rawPayload option Document the new behavior where Dapr wraps user-provided Avro schemas inside a CloudEvents envelope before registering with the Pulsar Schema Registry. Add the new `<topic-name>.rawPayload` metadata field for topics that need to skip CE wrapping and register the inner schema directly. Ref: dapr/components-contrib#4302 Signed-off-by: Javier Aliaga <javier@diagrid.io> * docs(pulsar): clarify processMode as component-level metadata and async backpressure processMode can now be set at the component level (not just subscription request metadata) and overridden per subscription. Updated description for maxConcurrentHandlers to document the fixed worker pool with backpressure and the fallback behavior when set to 0. Ref: dapr/components-contrib#4309 Signed-off-by: Javier Aliaga <javier@diagrid.io> * docs(pulsar): Apply suggestions Co-authored-by: Alice Gibbons <alicejgibbons@gmail.com> Signed-off-by: Javier Aliaga <javier@diagrid.io> --------- Signed-off-by: Javier Aliaga <javier@diagrid.io> Co-authored-by: Alice Gibbons <alicejgibbons@gmail.com> * chore: update Azure Static Web App base hostname to new account (#5095) Signed-off-by: Jorge André Gonçalves <goncalves.ja@pm.me> * chore: fix Azure Static Web App staging URL region suffix (#5096) Signed-off-by: Jorge André Gonçalves <goncalves.ja@pm.me> * chore: update Azure Static Web App to new instance (dapr-docs-site) (#5097) Signed-off-by: Jorge André Gonçalves <goncalves.ja@pm.me> * revert: restore original Azure Static Web App configuration (#5098) Signed-off-by: Jorge André Gonçalves <goncalves.ja@pm.me> * dapr v1.17.3 (#5089) Signed-off-by: Cassandra Coyle <cassie@diagrid.io> Co-authored-by: Josh van Leeuwen <me@joshvanl.dev> * Review comments Signed-off-by: joshvanl <me@joshvanl.dev> * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Josh van Leeuwen <me@joshvanl.dev> * Updates CLI version to 1.17.1 (#5107) Signed-off-by: joshvanl <me@joshvanl.dev> * Update dapr to version v1.17.4 (#5110) * Update dapr to version v1.17.4 Signed-off-by: joshvanl <me@joshvanl.dev> * Update daprdocs/content/en/operations/support/support-release-policy.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Josh van Leeuwen <me@joshvanl.dev> --------- Signed-off-by: joshvanl <me@joshvanl.dev> Signed-off-by: Josh van Leeuwen <me@joshvanl.dev> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * update to latest versions Signed-off-by: Cassandra Coyle <cassie@diagrid.io> * [1.17] docs(agents): announce v1.0 release for dapr agents in docs (#5121) * docs(agents): announce v1.0 release for dapr agents in docs Signed-off-by: Samantha Coyle <sam@diagrid.io> * style: updates for copilot feedback Signed-off-by: Samantha Coyle <sam@diagrid.io> * style: address feedback from mark Signed-off-by: Samantha Coyle <sam@diagrid.io> --------- Signed-off-by: Samantha Coyle <sam@diagrid.io> Co-authored-by: Mark Fussell <markfussell@gmail.com> * Update filename numbering to match quickstarts/ on dapr-agents (#5143) Signed-off-by: Sergio Herrera <627709+seherv@users.noreply.github.com> * Revert "Documentation for native-sidecar (#5041)" (#5146) This reverts commit 1534361. Signed-off-by: Marc Duiker <marcduiker@users.noreply.github.com> * Add Reo.dev and cookie banner (#5147) * Revert "Documentation for native-sidecar (#5041)" This reverts commit 1534361. Signed-off-by: Marc Duiker <marcduiker@users.noreply.github.com> * Add reo.dev and cookie banner Signed-off-by: Marc Duiker <marcduiker@users.noreply.github.com> --------- Signed-off-by: Marc Duiker <marcduiker@users.noreply.github.com> * Adds latest v1.17.7 (#5163) Signed-off-by: joshvanl <me@joshvanl.dev> * Fix typo: occured -> occurred (#5158) Signed-off-by: SAY-5 <saiasish.cnp@gmail.com> Co-authored-by: SAY-5 <saiasish.cnp@gmail.com> * docs(outbox): document outboxInternalTopic metadata field (#5155) Add documentation for the outboxInternalTopic metadata field which allows overriding the auto-generated internal outbox topic name. Changes: - Add outboxInternalTopic to metadata fields table - Add outboxInternalTopic to YAML example - Update internal outbox topic section with override explanation Related: dapr/dapr#8933, dapr/dapr#9855 Signed-off-by: Szymon Polom <szymon.polom@gmail.com> Co-authored-by: Mark Fussell <markfussell@gmail.com> * Fix asp.net core docs (#5164) Signed-off-by: Erwin <erwinkramer@hotmail.com> Co-authored-by: Mark Fussell <markfussell@gmail.com> * fix: correct broken ref shortcode link in (#5126) workflow-history-retention-policy Signed-off-by: Bilgin Ibryam <bibryam@gmail.com> Co-authored-by: Mark Fussell <markfussell@gmail.com> * Update tracing-overview.md (#5119) Add Middleware.io because it supports OTEL and its becoming highly popular in the observability space. Signed-off-by: Shekhar Luhar <luharshekhar2000@gmail.com> Co-authored-by: Mark Fussell <markfussell@gmail.com> * Add new configuration options for Pulsar component: redeliveryDelay, compressionType, and compressionLevel (#5116) Signed-off-by: MyMirelHub <15373565+MyMirelHub@users.noreply.github.com> Co-authored-by: Mark Fussell <markfussell@gmail.com> * docs(agents): document replay-aware logging for DurableAgent (#5149) * docs(agents): document context-aware logger for DurableAgent Signed-off-by: Rishabh Dewangan <107680241+Rishabh-git10@users.noreply.github.com> * docs: address review nits (imports and formatting) Signed-off-by: Rishabh Dewangan <107680241+Rishabh-git10@users.noreply.github.com> --------- Signed-off-by: Rishabh Dewangan <107680241+Rishabh-git10@users.noreply.github.com> Co-authored-by: Mark Fussell <markfussell@gmail.com> * docs(agents): add MistralChatClient to supported LLMs (#5108) * docs(agents): add MistralChatClient to supported LLMs Signed-off-by: Rishabh Dewangan <107680241+Rishabh-git10@users.noreply.github.com> * docs: explicitly document Mistral fallback behavior Signed-off-by: Rishabh Dewangan <107680241+Rishabh-git10@users.noreply.github.com> * docs(agents): add Prompty configuration template documentation Signed-off-by: Rishabh Dewangan <107680241+Rishabh-git10@users.noreply.github.com> * docs(agents): address review nits for Prompty and Mistral models Signed-off-by: Rishabh Dewangan <107680241+Rishabh-git10@users.noreply.github.com> --------- Signed-off-by: Rishabh Dewangan <107680241+Rishabh-git10@users.noreply.github.com> Co-authored-by: Sam <sam@diagrid.io> Co-authored-by: Mark Fussell <markfussell@gmail.com> * mirror update from components-contrib (#5061) Signed-off-by: Eric Jacobson <eric.jacobson@grafana.com> Co-authored-by: Marc Duiker <marcduiker@users.noreply.github.com> Co-authored-by: Mark Fussell <markfussell@gmail.com> --------- Signed-off-by: Marc Duiker <marcduiker@users.noreply.github.com> Signed-off-by: Whit Waldo <whit.waldo@innovian.net> Signed-off-by: joshvanl <me@joshvanl.dev> Signed-off-by: Mark Fussell <markfussell@gmail.com> Signed-off-by: Samantha Coyle <sam@diagrid.io> Signed-off-by: Sam <sam@diagrid.io> Signed-off-by: Javier Aliaga <javier@diagrid.io> Signed-off-by: Jorge André Gonçalves <goncalves.ja@pm.me> Signed-off-by: Cassandra Coyle <cassie@diagrid.io> Signed-off-by: Josh van Leeuwen <me@joshvanl.dev> Signed-off-by: Sergio Herrera <627709+seherv@users.noreply.github.com> Signed-off-by: SAY-5 <saiasish.cnp@gmail.com> Signed-off-by: Szymon Polom <szymon.polom@gmail.com> Signed-off-by: Erwin <erwinkramer@hotmail.com> Signed-off-by: Bilgin Ibryam <bibryam@gmail.com> Signed-off-by: Shekhar Luhar <luharshekhar2000@gmail.com> Signed-off-by: MyMirelHub <15373565+MyMirelHub@users.noreply.github.com> Signed-off-by: Rishabh Dewangan <107680241+Rishabh-git10@users.noreply.github.com> Signed-off-by: Eric Jacobson <eric.jacobson@grafana.com> Co-authored-by: Whit Waldo <whit.waldo@innovian.net> Co-authored-by: joshvanl <me@joshvanl.dev> Co-authored-by: Mark Fussell <markfussell@gmail.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Sam <sam@diagrid.io> Co-authored-by: Alice Gibbons <alicejgibbons@gmail.com> Co-authored-by: Yaron Schneider <schneider.yaron@live.com> Co-authored-by: Javier Aliaga <javier@diagrid.io> Co-authored-by: Jorge André Gonçalves <goncalves.ja@pm.me> Co-authored-by: Cassie Coyle <cassie@diagrid.io> Co-authored-by: seherv <627709+seherv@users.noreply.github.com> Co-authored-by: Sai Asish Y <say.apm35@gmail.com> Co-authored-by: SAY-5 <saiasish.cnp@gmail.com> Co-authored-by: Szymon Połom <szymon.polom@gmail.com> Co-authored-by: Erwin <4255748+erwinkramer@users.noreply.github.com> Co-authored-by: Bilgin Ibryam <bibryam@gmail.com> Co-authored-by: Shekhar Luhar <luharshekhar2000@gmail.com> Co-authored-by: Mirel <15373565+MyMirelHub@users.noreply.github.com> Co-authored-by: Rishabh Dewangan <107680241+Rishabh-git10@users.noreply.github.com> Co-authored-by: Eric Jacobson <erj826@gmail.com>

javier-aliaga requested review from a team as code owners March 24, 2026 15:22

javier-aliaga force-pushed the pulsar-avro-cloudevents branch from b45bc49 to bf4835e Compare March 24, 2026 16:32

JoshVanL requested a review from Copilot March 24, 2026 16:38

Copilot started reviewing on behalf of JoshVanL March 24, 2026 16:38 View session

Copilot AI reviewed Mar 24, 2026

View reviewed changes

javier-aliaga force-pushed the pulsar-avro-cloudevents branch from 32fa66a to 7340081 Compare March 25, 2026 08:35

javier-aliaga requested a review from Copilot March 25, 2026 08:36

Copilot started reviewing on behalf of javier-aliaga March 25, 2026 08:37 View session

javier-aliaga force-pushed the pulsar-avro-cloudevents branch from 7340081 to 290a970 Compare March 25, 2026 08:37

Copilot AI reviewed Mar 25, 2026

View reviewed changes

MyMirelHub approved these changes Mar 28, 2026

View reviewed changes

javier-aliaga force-pushed the pulsar-avro-cloudevents branch from 7e3321c to b06d0ca Compare March 28, 2026 10:29

javier-aliaga changed the title ~~docs(pulsar): add CloudEvents Avro schema wrapping and rawPayload option~~ docs(pulsar): add CloudEvents schema wrapping and rawSchema option for Avro and JSON schemas Mar 28, 2026

javier-aliaga changed the base branch from v1.17 to v1.16 March 28, 2026 10:32

javier-aliaga changed the base branch from v1.16 to v1.17 March 28, 2026 10:33

javier-aliaga requested a review from Copilot March 28, 2026 10:33

Copilot started reviewing on behalf of javier-aliaga March 28, 2026 10:34 View session

Copilot AI reviewed Mar 28, 2026

View reviewed changes

Comment thread daprdocs/content/en/reference/components-reference/supported-pubsub/setup-pulsar.md Outdated

javier-aliaga force-pushed the pulsar-avro-cloudevents branch from 85ddcd5 to c41a552 Compare March 30, 2026 07:29

javier-aliaga marked this pull request as draft March 30, 2026 08:19

javier-aliaga changed the title ~~docs(pulsar): add CloudEvents schema wrapping and rawSchema option for Avro and JSON schemas~~ docs(pulsar): add CloudEvents schema wrapping, rawschema option, and processMode improvements Mar 30, 2026

javier-aliaga marked this pull request as ready for review March 30, 2026 08:30

alicejgibbons suggested changes Mar 30, 2026

View reviewed changes

javier-aliaga force-pushed the pulsar-avro-cloudevents branch from 6ffa050 to 5db814b Compare March 30, 2026 14:39

javier-aliaga added 2 commits March 30, 2026 16:40

javier-aliaga force-pushed the pulsar-avro-cloudevents branch from 5db814b to 8f7849d Compare March 30, 2026 14:40

alicejgibbons reviewed Mar 30, 2026

View reviewed changes

Comment thread daprdocs/content/en/reference/components-reference/supported-pubsub/setup-pulsar.md Outdated

alicejgibbons approved these changes Mar 30, 2026

View reviewed changes

docs(pulsar): Apply suggestions

c0f7a46

Co-authored-by: Alice Gibbons <alicejgibbons@gmail.com> Signed-off-by: Javier Aliaga <javier@diagrid.io>

msfussell approved these changes Mar 31, 2026

View reviewed changes

msfussell merged commit d2d016d into dapr:v1.17 Mar 31, 2026
6 checks passed

Conversation

javier-aliaga commented Mar 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Description

Issue reference

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

alicejgibbons left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

msfussell left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

javier-aliaga commented Mar 24, 2026 •

edited

Loading