You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by "davsclaus (via GitHub)" <gi...@apache.org> on 2026/06/17 17:57:42 UTC
[PR] CAMEL-23789: Make component docs multi-DSL friendly (Wave 1) [camel]
davsclaus opened a new pull request, #24097:
URL: https://github.com/apache/camel/pull/24097
## 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](https://claude.com/claude-code)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] CAMEL-23789: Make component docs multi-DSL friendly (Wave 1) [camel]
Posted by "davsclaus (via GitHub)" <gi...@apache.org>.
davsclaus commented on code in PR #24097:
URL: https://github.com/apache/camel/pull/24097#discussion_r3434532503
##########
components/camel-ai/camel-openai/src/main/docs/openai-component.adoc:
##########
@@ -127,6 +131,25 @@ from("direct:chat")
+ "&mcpServer.tools.oauthProfile=keycloak");
----
+YAML::
++
+[source,yaml]
+----
+- route:
+ from:
+ uri: direct:chat
+ steps:
+ - to:
+ uri: openai:chat-completion
+ parameters:
+ model: gpt-4
+ oauthProfile: azure
+ mcpServer.tools.transportType: streamableHttp
+ mcpServer.tools.url: https://mcp.internal/mcp
+ mcpServer.tools.oauthProfile: keycloak
+----
+====
+
Review Comment:
thanks
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] CAMEL-23789: Make component docs multi-DSL friendly (Wave 1) [camel]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #24097:
URL: https://github.com/apache/camel/pull/24097#issuecomment-4733848403
:star2: Thank you for your contribution to the Apache Camel project! :star2:
:robot: CI automation will test this PR automatically.
:camel: 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](https://camel.apache.org/community/team/#committers) have access to the summary.
:warning: Be careful when sharing logs. Review their contents before sharing them publicly.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] CAMEL-23789: Make component docs multi-DSL friendly (Wave 1) [camel]
Posted by "davsclaus (via GitHub)" <gi...@apache.org>.
davsclaus merged PR #24097:
URL: https://github.com/apache/camel/pull/24097
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] CAMEL-23789: Make component docs multi-DSL friendly (Wave 1) [camel]
Posted by "apupier (via GitHub)" <gi...@apache.org>.
apupier commented on code in PR #24097:
URL: https://github.com/apache/camel/pull/24097#discussion_r3433449547
##########
components/camel-ai/camel-kserve/src/main/docs/kserve-component.adoc:
##########
@@ -145,13 +147,15 @@ void postprocess(Exchange exchange) {
}
----
+._Java-only: requires protobuf ModelInferRequest builder with header overrides_
+
.Specify the model name and version with headers
[source,java]
----
from("direct:infer-with-headers")
.setBody(constant(createRequest()))
- .setHeader(KServeConstants.MODEL_NAME, constant("simple"))
- .setHeader(KServeConstants.MODEL_VERSION, constant("1"))
+ .setHeader("CamelKServeModelName", constant("simple"))
+ .setHeader("CamelKServeModelVersion", constant("1"))
Review Comment:
I think we shoudl show using the constants which is a better practice
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] CAMEL-23789: Make component docs multi-DSL friendly (Wave 1) [camel]
Posted by "apupier (via GitHub)" <gi...@apache.org>.
apupier commented on code in PR #24097:
URL: https://github.com/apache/camel/pull/24097#discussion_r3433831170
##########
components/camel-ai/camel-openai/src/main/docs/openai-component.adoc:
##########
@@ -127,6 +131,25 @@ from("direct:chat")
+ "&mcpServer.tools.oauthProfile=keycloak");
----
+YAML::
++
+[source,yaml]
+----
+- route:
+ from:
+ uri: direct:chat
+ steps:
+ - to:
+ uri: openai:chat-completion
+ parameters:
+ model: gpt-4
+ oauthProfile: azure
+ mcpServer.tools.transportType: streamableHttp
+ mcpServer.tools.url: https://mcp.internal/mcp
+ mcpServer.tools.oauthProfile: keycloak
+----
+====
+
Review Comment:
missing xml
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org