Skip to content

CAMEL-23789: Make component docs multi-DSL friendly (Wave 1)#24097

Open
davsclaus wants to merge 42 commits into
mainfrom
feature/CAMEL-23789-wave1-multi-dsl-docs
Open

CAMEL-23789: Make component docs multi-DSL friendly (Wave 1)#24097
davsclaus wants to merge 42 commits into
mainfrom
feature/CAMEL-23789-wave1-multi-dsl-docs

Conversation

@davsclaus

@davsclaus davsclaus commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

Summary

Claude Code on behalf of Claus Ibsen

Makes 10 popular component documentation pages multi-DSL friendly by adding Java/XML/YAML tabs blocks for route examples, resolving Java constants to string values, and marking inherently Java-only examples.

Components updated: AWS S3, Azure Storage Blob, MongoDB, JMS, AWS SQS, AWS SNS, Kafka, File, HTTP, SQL

Changes per component:

  • Added [tabs] blocks with Java, XML, and YAML DSL equivalents for route examples
  • Resolved Java constants (e.g., KafkaConstants.KEY → "CamelKafkaKey", JmsConstants.JMS_DESTINATION → "CamelJmsDestination") to their string values
  • Added ._Java-only: description_ markers for examples that are inherently Java-only (ProducerTemplate test API, programmatic config, complex Java types)
  • Converted anonymous Processor classes to lambdas where appropriate
  • Removed string concatenation (+) in URIs, using plain single-line URIs instead
  • Fixed minor typos found during review (e.g., #m4yClient → #myClient in SQS docs)

Test plan

  • Verify AsciiDoc renders correctly (tabs blocks, Java-only markers, code blocks)
  • Spot-check XML examples use & for query parameter separators
  • Spot-check YAML examples use parameters: block for endpoint options
  • Verify no Java constants remain in the updated doc files

🤖 Generated with Claude Code

davsclaus and others added 14 commits June 17, 2026 18:15
@davsclaus @claude
CAMEL-23789: Make AWS S3 component docs multi-DSL friendly (Wave 1)
6d67e19 
Convert processor-based examples to declarative setHeader/setBody DSL,
add XML and YAML tabs for all route examples, resolve AWS2S3Constants
to string header values, add Java-only markers for programmatic config,
and convert streaming upload timestamp grouping examples to multi-DSL.

Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@davsclaus @claude
CAMEL-23789: Make Azure Storage Blob docs multi-DSL friendly (Wave 1)
c9ac372 
Convert processor-based examples to declarative setHeader/setBody DSL,
add XML and YAML tabs for all route examples, resolve all BlobConstants
to string header values, add Java-only markers for programmatic config,
and fix string concatenation in URIs.

Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@davsclaus @claude
CAMEL-23789: Make MongoDB component docs multi-DSL friendly (Wave 1)
c8b363d 
Resolve all MongoDbConstants to string header values, add Java-only
markers for Bson/ProducerTemplate examples, add tabs for count route,
fix prose references to use string header names, and remove duplicate
projection example.

Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@davsclaus @claude
CAMEL-23789: Make JMS component docs multi-DSL friendly (Wave 1)
43f7007 
Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@davsclaus @claude
CAMEL-23789: Make AWS SQS component docs multi-DSL friendly (Wave 1)
214d575 
Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@davsclaus @claude
CAMEL-23789: Make AWS SNS component docs multi-DSL friendly (Wave 1)
e405418 
Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@davsclaus @claude
CAMEL-23789: Make Kafka component docs multi-DSL friendly (Wave 1)
d480874 
Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@davsclaus @claude
CAMEL-23789: Make File component docs multi-DSL friendly (Wave 1)
2593c3c 
Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@davsclaus @claude
CAMEL-23789: Make HTTP component docs multi-DSL friendly (Wave 1)
4923399 
Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@davsclaus @claude
CAMEL-23789: Make SQL component docs multi-DSL friendly (Wave 1)
ea3b220 
Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@davsclaus @claude
CAMEL-23789: Make gRPC component docs multi-DSL friendly (Wave 1)
e888faf 
Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@davsclaus @claude
CAMEL-23789: Make AWS Bedrock component docs multi-DSL friendly (Wave 1)
cee31d8 
Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@davsclaus @claude
CAMEL-23789: Make AWS DynamoDB component docs multi-DSL friendly (Wav…
f5fb8e9 
…e 1)

Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@davsclaus @claude
CAMEL-23789: Make Elasticsearch component docs multi-DSL friendly (Wa…
95646b3 
…ve 1)

Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@github-actions

github-actions Bot commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

🌟 Thank you for your contribution to the Apache Camel project! 🌟
🤖 CI automation will test this PR automatically.

🐫 Apache Camel Committers, please review the following items:

  • First-time contributors require MANUAL approval for the GitHub Actions to run
  • You can use the command /component-test (camel-)component-name1 (camel-)component-name2.. to request a test from the test bot although they are normally detected and executed by CI.
  • You can label PRs using skip-tests and test-dependents to fine-tune the checks executed by this PR.
  • Build and test logs are available in the summary page. Only Apache Camel committers have access to the summary.

⚠️ Be careful when sharing logs. Review their contents before sharing them publicly.

@davsclaus @claude
CAMEL-23789: Make Salesforce component docs multi-DSL friendly (Wave 1)
83778c0 
Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
davsclaus and others added 8 commits June 17, 2026 20:28
@davsclaus @claude
CAMEL-23789: Make SEDA component docs multi-DSL friendly (Wave 1)
65102c8 
Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@davsclaus @claude
CAMEL-23789: Make Bean component docs multi-DSL friendly (Wave 1)
cf2fd08 
Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@davsclaus @claude
chore(docs): fix unterminated listing block in mongodb docs
400e1d7 
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@davsclaus @claude
CAMEL-23789: Make Vert.x HTTP component docs multi-DSL friendly (Wave 1)
696f06a 
Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@davsclaus @claude
CAMEL-23789: Make Mail component docs multi-DSL friendly (Wave 1)
4ae1b50 
Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@davsclaus @claude
CAMEL-23789: Make AWS EventBridge component docs multi-DSL friendly (…
1c65050 
…Wave 1)

Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@davsclaus @claude
CAMEL-23789: Make Reactive Streams component docs multi-DSL friendly …
35e911a 
…(Wave 1)

Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@davsclaus @claude
CAMEL-23789: Make Spring WS component docs multi-DSL friendly (Wave 1)
b5fcd05 
Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
davsclaus and others added 8 commits June 17, 2026 20:53
@davsclaus @claude
CAMEL-23789: Make CXF component docs multi-DSL friendly (Wave 1)
23b0c15 
Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@davsclaus @claude
CAMEL-23789: Make Azure Storage Data Lake component docs multi-DSL fr…
b8f4c2f 
…iendly (Wave 1)

Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@davsclaus @claude
CAMEL-23789: Make Netty HTTP component docs multi-DSL friendly (Wave 1)
a3a125d 
Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@davsclaus @claude
CAMEL-23789: Make Stripe component docs multi-DSL friendly (Wave 1)
24ad27d 
- Resolve StripeConstants references to string values (OBJECT_ID, METHOD_HEADER, METHOD_RETRIEVE, METHOD_UPDATE, METHOD_LIST, METHOD_CANCEL)
- Convert createCustomer JSON, REST payment, retrieveCustomer, cancelPayment, and auth examples to Java/XML/YAML tabs
- Add Java-only markers to Map.of() examples (createCustomer, paymentIntent, updatePayment, listCustomers, product+price, refund)
- Add Java-only markers to programmatic component configuration and error handling examples

Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@davsclaus @claude
CAMEL-23789: Make Dapr component docs multi-DSL friendly (Wave 1)
f9b9e66 
- Resolve all DaprConstants references to string values (CamelDaprVerb, CamelDaprConcurrency, etc.)
- Convert anonymous Processor classes to setHeader/setBody DSL equivalents
- Convert 14 producer examples to Java/XML/YAML tabs (invokeService, state save/get, pubSub, invokeBinding, lock tryLock/unlock, workflow scheduleNew/terminate/purge/suspend/resume/state/raiseEvent)
- Add Java-only markers to examples using SDK types (State, TransactionalStateOperation, Duration, List.of, Map.of)

Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@davsclaus @claude
CAMEL-23789: Make Neo4j component docs multi-DSL friendly (Wave 1)
806d26e 
- Resolve Neo4j.Headers and Neo4jConstants.Headers references to string values
- Add Java-only markers to all 14 ProducerTemplate examples
- Clean up indentation and code formatting

Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@davsclaus @claude
CAMEL-23789: Make OpenAI component docs multi-DSL friendly (Wave 1)
6fce606 
- Convert 6 simple route examples to Java/XML/YAML tabs (file prompt, image input, S3 image, media type header, JSON schema, schema resource)
- Add YAML tab to MCP OAuth example
- Add Java-only markers to SDK-specific examples (outputClass, SSLContextParameters, SimilarityUtils, conversation history, batch embeddings, multi-turn)

Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@davsclaus @claude
CAMEL-23789: Make Spring AI Chat component docs multi-DSL friendly (W…
3c42df8 
…ave 1)

- Convert simple chat route to Java/XML/YAML tabs
- Add Java-only markers to 14 SDK-specific examples (ChatMemory, VectorStore, Message types, @tool, ChatClient, multimodal, structured output, RAG, ProducerTemplate)

Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
davsclaus and others added 11 commits June 17, 2026 21:17
@davsclaus @claude
CAMEL-23789: Make IBM watsonx.ai component docs multi-DSL friendly (W…
55c930f 
…ave 1)

Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@davsclaus @claude
CAMEL-23789: Make LangChain4j Agent component docs multi-DSL friendly…
2f3d5f2 
… (Wave 1)

Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@davsclaus @claude
CAMEL-23789: Make MINA SFTP component docs multi-DSL friendly (Wave 1)
a8b9fc1 
Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@davsclaus @claude
CAMEL-23789: Make Hazelcast Queue component docs multi-DSL friendly (…
a2f456d 
…Wave 1)

Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@davsclaus @claude
CAMEL-23789: Make Dynamic Router Control component docs multi-DSL fri…
af99467 
…endly (Wave 1)

Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@davsclaus @claude
CAMEL-23789: Make Flink component docs multi-DSL friendly (Wave 1)
390f342 
Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@davsclaus @claude
CAMEL-23789: Make CyberArk Vault component docs multi-DSL friendly (W…
daaf850 
…ave 1)

Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@davsclaus @claude
CAMEL-23789: Make Google Cloud Functions component docs multi-DSL fri…
55dbc83 
…endly (Wave 1)

Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@davsclaus @claude
CAMEL-23789: Make Google Cloud Vision component docs multi-DSL friend…
2a13278 
…ly (Wave 1)

Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@davsclaus @claude
CAMEL-23789: Make Dynamic Router component docs multi-DSL friendly (W…
a88a663 
…ave 1)

Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@davsclaus @claude
CAMEL-23789: Make AWS Athena component docs multi-DSL friendly (Wave 1)
e9d6ade 
Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

components components-ai components-aws components-azure components-jms components-kafka docs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@davsclaus