chore: Improve exchange pattern documentation to clarify behavior - #25033
Conversation
|
🌟 Thank you for your contribution to the Apache Camel project! 🌟 🐫 Apache Camel Committers, please review the following items:
|
78614dd to
11ada52
Compare
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
11ada52 to
b31713c
Compare
gnodet
left a comment
There was a problem hiding this comment.
Clean, well-written documentation improvement that clarifies exchange pattern behavior — the "How It Works" sections are technically accurate and address recurring user confusion about MEP being a component-level contract vs. processor-level control.
CI note: Build 25 fails because the generated catalog copies of event-message.adoc and requestReply-eip.adoc under catalog/camel-catalog/src/generated/resources/ were not regenerated and committed. Running mvn clean install -Dquickly should regenerate them.
Pre-existing observation (not introduced by this PR): In event-message.adoc line 20, xref:ROOT:jms-component.adoc[File] links to JMS but displays "File" — should be xref:ROOT:file-component.adoc[File]. Could be fixed opportunistically while editing this file.
LGTM! 👍
This review was generated by an AI agent and may contain inaccuracies. Please verify all suggestions before applying.
Claude Code on behalf of Guillaume Nodet
… link Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
|
Thanks @gnodet for the review! Addressed both items:
|
|
🧪 CI tested the following changed modules:
🔬 Scalpel shadow comparison — Scalpel: 485 tested, 27 compile-only — current: 483 all testedMaveniverse Scalpel detected 512 affected modules (current approach: 483).
|
Summary
Claude Code on behalf of davsclaus
Improves the exchange pattern documentation to clarify how
InOnlyandInOutactually work, addressing recurring confusion from users on the mailing list.Changes:
exchange-pattern.adoc— Added "How Exchange Pattern Works" section explaining it is a component-level contract, does not affect processors likesetBody, and clarifying async vs sync component behavior (seda/jms fire-and-forget vs direct same-thread)requestReply-eip.adoc— Added "How It Works" section explainingInOutis a contract with the endpoint, not a flow control mechanismevent-message.adoc— Added "How It Works" section forInOnlywith the same clarificationsevent-message.adoc— Fixed pre-existing broken xref link (was linking to JMS with "File" label instead of File component)event-message.adocandrequestReply-eip.adocPrompted by discussion with Raymond Meester on the Camel users mailing list.
Test plan
mvn clean install -Dquickly)🤖 Generated with Claude Code
Co-Authored-By: Claude Opus 4.6 noreply@anthropic.com