You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by fm...@apache.org on 2026/09/16 10:12:19 UTC
(camel) branch main updated: docs: mention platform-http in the rest component example list (#26498)
This is an automated email from the ASF dual-hosted git repository.
Croway pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new 15c72e485caa docs: mention platform-http in the rest component example list (#26498)
15c72e485caa is described below
commit 15c72e485caa0539654e3d68daf3f575f6b72c90
Author: Federico Mariani <34...@users.noreply.github.com>
AuthorDate: Wed Sep 16 12:12:11 2026 +0200
docs: mention platform-http in the rest component example list (#26498)
* docs: mention platform-http in the rest component example list
The camel.rest.component / RestConfiguration.setComponent javadoc and
@Metadata description listed "netty-http, jetty, servlet, undertow" as
example rest consumer components, but omitted platform-http even though
it already appears in the @Metadata enums list and is the component
Spring Boot and Quarkus users are now steered towards for REST DSL
routes.
* Regen
---
.../org/apache/camel/catalog/models/restConfiguration.json | 2 +-
.../resources/org/apache/camel/catalog/schemas/camel-spring.xsd | 3 ++-
.../resources/org/apache/camel/catalog/schemas/camel-xml-io.xsd | 3 ++-
.../org/apache/camel/catalog/schemas/camelYamlDsl-model.json | 2 +-
.../src/main/java/org/apache/camel/spi/RestConfiguration.java | 3 ++-
.../META-INF/org/apache/camel/model/rest/restConfiguration.json | 2 +-
.../org/apache/camel/model/rest/RestConfigurationDefinition.java | 2 +-
.../java/org/apache/camel/main/RestConfigurationProperties.java | 8 ++++----
.../apache/camel/dsl/yaml/deserializers/ModelDeserializers.java | 2 +-
.../src/generated/resources/schema/camelYamlDsl-canonical.json | 2 +-
.../src/generated/resources/schema/camelYamlDsl-model.json | 2 +-
.../src/generated/resources/schema/camelYamlDsl.json | 2 +-
12 files changed, 18 insertions(+), 15 deletions(-)
diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/restConfiguration.json b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/restConfiguration.json
index d300437120e5..84084eb8babc 100644
--- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/restConfiguration.json
+++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/restConfiguration.json
@@ -12,7 +12,7 @@
"output": false
},
"properties": {
- "component": { "index": 0, "kind": "attribute", "displayName": "Component", "group": "common", "required": false, "type": "enum", "javaType": "java.lang.String", "enum": [ "platform-http", "servlet", "jetty", "undertow", "netty-http", "coap" ], "deprecated": false, "autowired": false, "secret": false, "description": "The Camel Rest component to use for the REST transport (consumer), such as netty-http, jetty, servlet, undertow." },
+ "component": { "index": 0, "kind": "attribute", "displayName": "Component", "group": "common", "required": false, "type": "enum", "javaType": "java.lang.String", "enum": [ "platform-http", "servlet", "jetty", "undertow", "netty-http", "coap" ], "deprecated": false, "autowired": false, "secret": false, "description": "The Camel Rest component to use for the REST transport (consumer), such as platform-http, netty-http, jetty, servlet, undertow." },
"apiComponent": { "index": 1, "kind": "attribute", "displayName": "Api Component", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "enum", "javaType": "java.lang.String", "enum": [ "openapi", "swagger" ], "deprecated": false, "autowired": false, "secret": false, "description": "The name of the Camel component to use as the REST API (such as OpenApi)." },
"producerComponent": { "index": 2, "kind": "attribute", "displayName": "Producer Component", "group": "producer (advanced)", "label": "producer,advanced", "required": false, "type": "enum", "javaType": "java.lang.String", "enum": [ "vertx-http", "http", "undertow", "netty-http" ], "deprecated": false, "autowired": false, "secret": false, "description": "Sets the name of the Camel component to use as the REST producer." },
"scheme": { "index": 3, "kind": "attribute", "displayName": "Scheme", "group": "common", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The scheme to use for exposing the REST service. Usually http or https is supported." },
diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-spring.xsd b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-spring.xsd
index c83e2eac6cb9..cf3e65e7ac17 100644
--- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-spring.xsd
+++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-spring.xsd
@@ -15067,7 +15067,8 @@ Allows to configure custom validation levels when using camel-openapi-validator
<xs:annotation>
<xs:documentation xml:lang="en">
<![CDATA[
-The Camel Rest component to use for the REST transport (consumer), such as netty-http, jetty, servlet, undertow.
+The Camel Rest component to use for the REST transport (consumer), such as platform-http, netty-http, jetty, servlet,
+undertow.
]]>
</xs:documentation>
</xs:annotation>
diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-xml-io.xsd b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-xml-io.xsd
index 1bb3fae89ab9..04336c3ce441 100644
--- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-xml-io.xsd
+++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-xml-io.xsd
@@ -14210,7 +14210,8 @@ Allows to configure custom validation levels when using camel-openapi-validator
<xs:annotation>
<xs:documentation xml:lang="en">
<![CDATA[
-The Camel Rest component to use for the REST transport (consumer), such as netty-http, jetty, servlet, undertow.
+The Camel Rest component to use for the REST transport (consumer), such as platform-http, netty-http, jetty, servlet,
+undertow.
]]>
</xs:documentation>
</xs:annotation>
diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camelYamlDsl-model.json b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camelYamlDsl-model.json
index 733459d37eb9..1bb90b40780e 100644
--- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camelYamlDsl-model.json
+++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camelYamlDsl-model.json
@@ -18601,7 +18601,7 @@
"name" : "component",
"type" : "enum",
"enum" : [ "platform-http", "servlet", "jetty", "undertow", "netty-http", "coap" ],
- "description" : "The Camel Rest component to use for the REST transport (consumer), such as netty-http, jetty, servlet, undertow.",
+ "description" : "The Camel Rest component to use for the REST transport (consumer), such as platform-http, netty-http, jetty, servlet, undertow.",
"title" : "Component",
"displayName" : "Component",
"kind" : "attribute",
diff --git a/core/camel-api/src/main/java/org/apache/camel/spi/RestConfiguration.java b/core/camel-api/src/main/java/org/apache/camel/spi/RestConfiguration.java
index 05e8d01a514b..b6408cc35b31 100644
--- a/core/camel-api/src/main/java/org/apache/camel/spi/RestConfiguration.java
+++ b/core/camel-api/src/main/java/org/apache/camel/spi/RestConfiguration.java
@@ -110,7 +110,8 @@ public class RestConfiguration {
/**
* Sets the name of the Camel component to use as the REST consumer
*
- * @param componentName the name of the component (such as netty-http, jetty, servlet, undertow, etc.)
+ * @param componentName the name of the component (such as platform-http, netty-http, jetty, servlet, undertow,
+ * etc.)
*/
public void setComponent(String componentName) {
this.component = Objects.requireNonNull(componentName, "componentName");
diff --git a/core/camel-core-model/src/generated/resources/META-INF/org/apache/camel/model/rest/restConfiguration.json b/core/camel-core-model/src/generated/resources/META-INF/org/apache/camel/model/rest/restConfiguration.json
index d300437120e5..84084eb8babc 100644
--- a/core/camel-core-model/src/generated/resources/META-INF/org/apache/camel/model/rest/restConfiguration.json
+++ b/core/camel-core-model/src/generated/resources/META-INF/org/apache/camel/model/rest/restConfiguration.json
@@ -12,7 +12,7 @@
"output": false
},
"properties": {
- "component": { "index": 0, "kind": "attribute", "displayName": "Component", "group": "common", "required": false, "type": "enum", "javaType": "java.lang.String", "enum": [ "platform-http", "servlet", "jetty", "undertow", "netty-http", "coap" ], "deprecated": false, "autowired": false, "secret": false, "description": "The Camel Rest component to use for the REST transport (consumer), such as netty-http, jetty, servlet, undertow." },
+ "component": { "index": 0, "kind": "attribute", "displayName": "Component", "group": "common", "required": false, "type": "enum", "javaType": "java.lang.String", "enum": [ "platform-http", "servlet", "jetty", "undertow", "netty-http", "coap" ], "deprecated": false, "autowired": false, "secret": false, "description": "The Camel Rest component to use for the REST transport (consumer), such as platform-http, netty-http, jetty, servlet, undertow." },
"apiComponent": { "index": 1, "kind": "attribute", "displayName": "Api Component", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "enum", "javaType": "java.lang.String", "enum": [ "openapi", "swagger" ], "deprecated": false, "autowired": false, "secret": false, "description": "The name of the Camel component to use as the REST API (such as OpenApi)." },
"producerComponent": { "index": 2, "kind": "attribute", "displayName": "Producer Component", "group": "producer (advanced)", "label": "producer,advanced", "required": false, "type": "enum", "javaType": "java.lang.String", "enum": [ "vertx-http", "http", "undertow", "netty-http" ], "deprecated": false, "autowired": false, "secret": false, "description": "Sets the name of the Camel component to use as the REST producer." },
"scheme": { "index": 3, "kind": "attribute", "displayName": "Scheme", "group": "common", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The scheme to use for exposing the REST service. Usually http or https is supported." },
diff --git a/core/camel-core-model/src/main/java/org/apache/camel/model/rest/RestConfigurationDefinition.java b/core/camel-core-model/src/main/java/org/apache/camel/model/rest/RestConfigurationDefinition.java
index 4d43bd0bf086..1eaf17a8ccbc 100644
--- a/core/camel-core-model/src/main/java/org/apache/camel/model/rest/RestConfigurationDefinition.java
+++ b/core/camel-core-model/src/main/java/org/apache/camel/model/rest/RestConfigurationDefinition.java
@@ -42,7 +42,7 @@ import org.apache.camel.support.CamelContextHelper;
public class RestConfigurationDefinition {
@XmlAttribute
- @Metadata(description = "The Camel Rest component to use for the REST transport (consumer), such as netty-http, jetty, servlet, undertow.",
+ @Metadata(description = "The Camel Rest component to use for the REST transport (consumer), such as platform-http, netty-http, jetty, servlet, undertow.",
enums = "platform-http,servlet,jetty,undertow,netty-http,coap")
private String component;
@XmlAttribute
diff --git a/core/camel-main/src/main/java/org/apache/camel/main/RestConfigurationProperties.java b/core/camel-main/src/main/java/org/apache/camel/main/RestConfigurationProperties.java
index 3bda60c37b54..10bb81d06e8a 100644
--- a/core/camel-main/src/main/java/org/apache/camel/main/RestConfigurationProperties.java
+++ b/core/camel-main/src/main/java/org/apache/camel/main/RestConfigurationProperties.java
@@ -59,10 +59,10 @@ public class RestConfigurationProperties extends RestConfiguration implements Bo
// --------------------------------------------------------------
/**
- * The Camel Rest component to use for the REST transport (consumer), such as netty-http, jetty, servlet, undertow.
- * If no component has been explicit configured, then Camel will lookup if there is a Camel component that
- * integrates with the Rest DSL, or if a org.apache.camel.spi.RestConsumerFactory is registered in the registry. If
- * either one is found, then that is being used.
+ * The Camel Rest component to use for the REST transport (consumer), such as platform-http, netty-http, jetty,
+ * servlet, undertow. If no component has been explicit configured, then Camel will lookup if there is a Camel
+ * component that integrates with the Rest DSL, or if a org.apache.camel.spi.RestConsumerFactory is registered in
+ * the registry. If either one is found, then that is being used.
*/
public RestConfigurationProperties withComponent(String component) {
setComponent(component);
diff --git a/dsl/camel-yaml-dsl/camel-yaml-dsl-deserializers/src/generated/java/org/apache/camel/dsl/yaml/deserializers/ModelDeserializers.java b/dsl/camel-yaml-dsl/camel-yaml-dsl-deserializers/src/generated/java/org/apache/camel/dsl/yaml/deserializers/ModelDeserializers.java
index 87fc1c97446c..a10bf691ca12 100644
--- a/dsl/camel-yaml-dsl/camel-yaml-dsl-deserializers/src/generated/java/org/apache/camel/dsl/yaml/deserializers/ModelDeserializers.java
+++ b/dsl/camel-yaml-dsl/camel-yaml-dsl-deserializers/src/generated/java/org/apache/camel/dsl/yaml/deserializers/ModelDeserializers.java
@@ -14617,7 +14617,7 @@ public final class ModelDeserializers extends YamlDeserializerSupport {
@YamlProperty(name = "bindingPackageScan", type = "string", description = "Package name to use as base (offset) for classpath scanning of POJO classes are located when using binding mode is enabled for JSon or XML. Multiple package names can be separated by comma.", displayName = "Binding Package Scan"),
@YamlProperty(name = "clientRequestValidation", type = "boolean", defaultValue = "false", description = "Whether to enable validation of the client request to check whether Content-Type/Accept headers, required parameters, and message body are valid.", displayName = "Client Request Validation"),
@YamlProperty(name = "clientResponseValidation", type = "boolean", defaultValue = "false", description = "Whether to validate what Camel is returning as response to the client, such as checking status-code, Content-Type, and headers match the Rest DSL response definition.", displayName = "Client Response Validation"),
- @YamlProperty(name = "component", type = "enum:platform-http,servlet,jetty,undertow,netty-http,coap", description = "The Camel Rest component to use for the REST transport (consumer), such as netty-http, jetty, servlet, undertow.", displayName = "Component"),
+ @YamlProperty(name = "component", type = "enum:platform-http,servlet,jetty,undertow,netty-http,coap", description = "The Camel Rest component to use for the REST transport (consumer), such as platform-http, netty-http, jetty, servlet, undertow.", displayName = "Component"),
@YamlProperty(name = "componentProperty", type = "array:org.apache.camel.model.rest.RestPropertyDefinition", description = "Allows to configure as many additional properties for the rest component in use.", displayName = "Component Property"),
@YamlProperty(name = "consumerProperty", type = "array:org.apache.camel.model.rest.RestPropertyDefinition", description = "Allows to configure as many additional properties for the rest consumer in use.", displayName = "Consumer Property"),
@YamlProperty(name = "contextPath", type = "string", description = "Sets a leading context-path the REST services will be using. This can be used when using components such as camel-servlet where the deployed web application is deployed using a context-path.", displayName = "Context Path"),
diff --git a/dsl/camel-yaml-dsl/camel-yaml-dsl/src/generated/resources/schema/camelYamlDsl-canonical.json b/dsl/camel-yaml-dsl/camel-yaml-dsl/src/generated/resources/schema/camelYamlDsl-canonical.json
index af432e58a8e6..c9283f62401e 100644
--- a/dsl/camel-yaml-dsl/camel-yaml-dsl/src/generated/resources/schema/camelYamlDsl-canonical.json
+++ b/dsl/camel-yaml-dsl/camel-yaml-dsl/src/generated/resources/schema/camelYamlDsl-canonical.json
@@ -12361,7 +12361,7 @@
"component" : {
"type" : "string",
"title" : "Component",
- "description" : "The Camel Rest component to use for the REST transport (consumer), such as netty-http, jetty, servlet, undertow.",
+ "description" : "The Camel Rest component to use for the REST transport (consumer), such as platform-http, netty-http, jetty, servlet, undertow.",
"enum" : [ "platform-http", "servlet", "jetty", "undertow", "netty-http", "coap" ]
},
"componentProperty" : {
diff --git a/dsl/camel-yaml-dsl/camel-yaml-dsl/src/generated/resources/schema/camelYamlDsl-model.json b/dsl/camel-yaml-dsl/camel-yaml-dsl/src/generated/resources/schema/camelYamlDsl-model.json
index 733459d37eb9..1bb90b40780e 100644
--- a/dsl/camel-yaml-dsl/camel-yaml-dsl/src/generated/resources/schema/camelYamlDsl-model.json
+++ b/dsl/camel-yaml-dsl/camel-yaml-dsl/src/generated/resources/schema/camelYamlDsl-model.json
@@ -18601,7 +18601,7 @@
"name" : "component",
"type" : "enum",
"enum" : [ "platform-http", "servlet", "jetty", "undertow", "netty-http", "coap" ],
- "description" : "The Camel Rest component to use for the REST transport (consumer), such as netty-http, jetty, servlet, undertow.",
+ "description" : "The Camel Rest component to use for the REST transport (consumer), such as platform-http, netty-http, jetty, servlet, undertow.",
"title" : "Component",
"displayName" : "Component",
"kind" : "attribute",
diff --git a/dsl/camel-yaml-dsl/camel-yaml-dsl/src/generated/resources/schema/camelYamlDsl.json b/dsl/camel-yaml-dsl/camel-yaml-dsl/src/generated/resources/schema/camelYamlDsl.json
index ad468f6080b3..5a0e9ba16d5c 100644
--- a/dsl/camel-yaml-dsl/camel-yaml-dsl/src/generated/resources/schema/camelYamlDsl.json
+++ b/dsl/camel-yaml-dsl/camel-yaml-dsl/src/generated/resources/schema/camelYamlDsl.json
@@ -14814,7 +14814,7 @@
"component" : {
"type" : "string",
"title" : "Component",
- "description" : "The Camel Rest component to use for the REST transport (consumer), such as netty-http, jetty, servlet, undertow.",
+ "description" : "The Camel Rest component to use for the REST transport (consumer), such as platform-http, netty-http, jetty, servlet, undertow.",
"enum" : [ "platform-http", "servlet", "jetty", "undertow", "netty-http", "coap" ]
},
"componentProperty" : {