You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2024/03/01 08:52:01 UTC
(camel) 01/01: CAMEL-20490: rest-dsl should turn off useXForwardHeaders by default.
This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch xforward
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 893e490c10da3b709bc9a861829ea948756fb51e
Author: Claus Ibsen <cl...@gmail.com>
AuthorDate: Fri Mar 1 09:51:44 2024 +0100
CAMEL-20490: rest-dsl should turn off useXForwardHeaders by default.
---
.../main/camel-main-configuration-metadata.json | 2 +-
.../camel/catalog/models/restConfiguration.json | 2 +-
.../apache/camel/catalog/schemas/camel-spring.xsd | 5 ++++-
.../org/apache/camel/spi/RestConfiguration.java | 18 +++++++++-------
.../apache/camel/model/rest/restConfiguration.json | 2 +-
.../model/rest/RestConfigurationDefinition.java | 24 +++++++++++++++-------
.../camel-main-configuration-metadata.json | 2 +-
core/camel-main/src/main/docs/main.adoc | 2 +-
.../camel/main/RestConfigurationProperties.java | 8 +++++---
.../ROOT/pages/camel-4x-upgrade-guide-4_5.adoc | 2 ++
.../dsl/yaml/deserializers/ModelDeserializers.java | 2 +-
.../generated/resources/schema/camelYamlDsl.json | 2 +-
12 files changed, 46 insertions(+), 25 deletions(-)
diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/main/camel-main-configuration-metadata.json b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/main/camel-main-configuration-metadata.json
index 1f763aafe27..2c8368e3122 100644
--- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/main/camel-main-configuration-metadata.json
+++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/main/camel-main-configuration-metadata.json
@@ -233,7 +233,7 @@
{ "name": "camel.rest.producerComponent", "description": "Sets the name of the Camel component to use as the REST producer", "sourceType": "org.apache.camel.spi.RestConfiguration", "type": "string", "javaType": "java.lang.String" },
{ "name": "camel.rest.scheme", "description": "Sets the scheme to use by the REST consumer", "sourceType": "org.apache.camel.spi.RestConfiguration", "type": "string", "javaType": "java.lang.String" },
{ "name": "camel.rest.skipBindingOnErrorCode", "description": "Whether to skip binding output if there is a custom HTTP error code, and instead use the response body as-is. This option is default true.", "sourceType": "org.apache.camel.spi.RestConfiguration", "type": "boolean", "javaType": "boolean", "defaultValue": true },
- { "name": "camel.rest.useXForwardHeaders", "description": "Whether to use X-Forward headers to set host etc. for Swagger. This option is default true.", "sourceType": "org.apache.camel.spi.RestConfiguration", "type": "boolean", "javaType": "boolean", "defaultValue": true },
+ { "name": "camel.rest.useXForwardHeaders", "description": "Whether to use X-Forward headers to set host etc. for OpenApi. This may be needed in special cases involving reverse-proxy and networking going from HTTP to HTTPS etc. Then the proxy can send X-Forward headers (X-Forwarded-Proto) that influences the host names in the OpenAPI schema that camel-openapi-java generates from Rest DSL routes.", "sourceType": "org.apache.camel.spi.RestConfiguration", "type": "boolean", "javaType": " [...]
{ "name": "camel.rest.xmlDataFormat", "description": "Sets a custom xml data format to be used. Important: This option is only for setting a custom name of the data format, not to refer to an existing data format instance.", "sourceType": "org.apache.camel.spi.RestConfiguration", "type": "string", "javaType": "java.lang.String" },
{ "name": "camel.routecontroller.backOffDelay", "description": "Backoff delay in millis when restarting a route that failed to startup.", "sourceType": "org.apache.camel.main.RouteControllerConfigurationProperties", "type": "integer", "javaType": "long", "defaultValue": 2000 },
{ "name": "camel.routecontroller.backOffMaxAttempts", "description": "Backoff maximum number of attempts to restart a route that failed to startup. When this threshold has been exceeded then the controller will give up attempting to restart the route, and the route will remain as stopped.", "sourceType": "org.apache.camel.main.RouteControllerConfigurationProperties", "type": "integer", "javaType": "long" },
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 2fff84c90f0..8f6eabdc526 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
@@ -19,7 +19,7 @@
"host": { "index": 4, "kind": "attribute", "displayName": "Host", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The hostname to use for exposing the REST service." },
"port": { "index": 5, "kind": "attribute", "displayName": "Port", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The port number to use for exposing the REST service. Notice if you use servlet component then the port number configured here does not apply, as the port number in use is the actual port number the servlet component is using. eg if using Apache Tomcat its the tomcat http port, [...]
"apiHost": { "index": 6, "kind": "attribute", "displayName": "Api Host", "label": "consumer,advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "To use a specific hostname for the API documentation (such as swagger or openapi) This can be used to override the generated host with this configured hostname" },
- "useXForwardHeaders": { "index": 7, "kind": "attribute", "displayName": "Use XForward Headers", "label": "consumer,advanced", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether to use X-Forward headers for Host and related setting. The default value is true." },
+ "useXForwardHeaders": { "index": 7, "kind": "attribute", "displayName": "Use XForward Headers", "label": "consumer,advanced", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Whether to use X-Forward headers to set host etc. for OpenApi. This may be needed in special cases involving reverse-proxy and networking going from HTTP to HTTPS etc. Then the proxy can send X- [...]
"producerApiDoc": { "index": 8, "kind": "attribute", "displayName": "Producer Api Doc", "label": "producer,advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Sets the location of the api document the REST producer will use to validate the REST uri and query parameters are valid accordingly to the api document. The location of the api document is loaded from classpath by default, but [...]
"contextPath": { "index": 9, "kind": "attribute", "displayName": "Context Path", "label": "consumer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "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. Or for components such as camel-jetty or camel-netty [...]
"apiContextPath": { "index": 10, "kind": "attribute", "displayName": "Api Context Path", "label": "consumer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Sets a leading API context-path the REST API 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." },
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 f3ad55422af..9535033cb44 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
@@ -16637,7 +16637,10 @@ generated host with this configured hostname.
<xs:annotation>
<xs:documentation xml:lang="en">
<![CDATA[
-Whether to use X-Forward headers for Host and related setting. The default value is true. Default value: true
+Whether to use X-Forward headers to set host etc. for OpenApi. This may be needed in special cases involving
+reverse-proxy and networking going from HTTP to HTTPS etc. Then the proxy can send X-Forward headers (X-Forwarded-Proto)
+that influences the host names in the OpenAPI schema that camel-openapi-java generates from Rest DSL routes. Default
+value: false
]]>
</xs:documentation>
</xs:annotation>
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 5cc46647a6e..3f6457e8f11 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
@@ -54,7 +54,7 @@ public class RestConfiguration {
private String producerApiDoc;
private String scheme;
private String host;
- private boolean useXForwardHeaders = true;
+ private boolean useXForwardHeaders;
private String apiHost;
private int port;
private String contextPath;
@@ -172,18 +172,22 @@ public class RestConfiguration {
}
/**
- * Whether to use X-Forward headers to set host etc. for Swagger.
- * <p/>
- * This option is default <tt>true</tt>.
+ * Whether to use X-Forward headers to set host etc. for OpenApi.
+ *
+ * This may be needed in special cases involving reverse-proxy and networking going from HTTP to HTTPS etc.
+ * Then the proxy can send X-Forward headers (X-Forwarded-Proto) that influences the host names in the OpenAPI schema
+ * that camel-openapi-java generates from Rest DSL routes.
*/
public boolean isUseXForwardHeaders() {
return useXForwardHeaders;
}
/**
- * Whether to use X-Forward headers to set host etc. for Swagger.
- * <p/>
- * This option is default <tt>true</tt>.
+ * Whether to use X-Forward headers to set host etc. for OpenApi.
+ *
+ * This may be needed in special cases involving reverse-proxy and networking going from HTTP to HTTPS etc.
+ * Then the proxy can send X-Forward headers (X-Forwarded-Proto) that influences the host names in the OpenAPI schema
+ * that camel-openapi-java generates from Rest DSL routes.
*/
public void setUseXForwardHeaders(boolean useXForwardHeaders) {
this.useXForwardHeaders = useXForwardHeaders;
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 2fff84c90f0..8f6eabdc526 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
@@ -19,7 +19,7 @@
"host": { "index": 4, "kind": "attribute", "displayName": "Host", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The hostname to use for exposing the REST service." },
"port": { "index": 5, "kind": "attribute", "displayName": "Port", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "The port number to use for exposing the REST service. Notice if you use servlet component then the port number configured here does not apply, as the port number in use is the actual port number the servlet component is using. eg if using Apache Tomcat its the tomcat http port, [...]
"apiHost": { "index": 6, "kind": "attribute", "displayName": "Api Host", "label": "consumer,advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "To use a specific hostname for the API documentation (such as swagger or openapi) This can be used to override the generated host with this configured hostname" },
- "useXForwardHeaders": { "index": 7, "kind": "attribute", "displayName": "Use XForward Headers", "label": "consumer,advanced", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether to use X-Forward headers for Host and related setting. The default value is true." },
+ "useXForwardHeaders": { "index": 7, "kind": "attribute", "displayName": "Use XForward Headers", "label": "consumer,advanced", "required": false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Whether to use X-Forward headers to set host etc. for OpenApi. This may be needed in special cases involving reverse-proxy and networking going from HTTP to HTTPS etc. Then the proxy can send X- [...]
"producerApiDoc": { "index": 8, "kind": "attribute", "displayName": "Producer Api Doc", "label": "producer,advanced", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Sets the location of the api document the REST producer will use to validate the REST uri and query parameters are valid accordingly to the api document. The location of the api document is loaded from classpath by default, but [...]
"contextPath": { "index": 9, "kind": "attribute", "displayName": "Context Path", "label": "consumer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "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. Or for components such as camel-jetty or camel-netty [...]
"apiContextPath": { "index": 10, "kind": "attribute", "displayName": "Api Context Path", "label": "consumer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Sets a leading API context-path the REST API 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." },
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 7e3d15efe92..ee6cd0feb5d 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
@@ -59,7 +59,7 @@ public class RestConfigurationDefinition {
@Metadata(label = "consumer,advanced")
private String apiHost;
@XmlAttribute
- @Metadata(label = "consumer,advanced", javaType = "java.lang.Boolean", defaultValue = "true")
+ @Metadata(label = "consumer,advanced", javaType = "java.lang.Boolean")
private String useXForwardHeaders;
@XmlAttribute
@Metadata(label = "producer,advanced")
@@ -491,9 +491,11 @@ public class RestConfigurationDefinition {
}
/**
- * Whether to use X-Forward headers for Host and related setting.
- * <p/>
- * The default value is true.
+ * Whether to use X-Forward headers to set host etc. for OpenApi.
+ *
+ * This may be needed in special cases involving reverse-proxy and networking going from HTTP to HTTPS etc.
+ * Then the proxy can send X-Forward headers (X-Forwarded-Proto) that influences the host names in the OpenAPI schema
+ * that camel-openapi-java generates from Rest DSL routes.
*/
public void setUseXForwardHeaders(String useXForwardHeaders) {
this.useXForwardHeaders = useXForwardHeaders;
@@ -867,14 +869,18 @@ public class RestConfigurationDefinition {
}
/**
- * Shortcut for setting the {@code Access-Control-Allow-Credentials} header.
+ * Shortcut for setting the Access-Control-Allow-Credentials header.
*/
public RestConfigurationDefinition corsAllowCredentials(boolean corsAllowCredentials) {
return corsHeaderProperty("Access-Control-Allow-Credentials", String.valueOf(corsAllowCredentials));
}
/**
- * To specify whether to use X-Forward headers for Host and related setting
+ * Whether to use X-Forward headers to set host etc. for OpenApi.
+ *
+ * This may be needed in special cases involving reverse-proxy and networking going from HTTP to HTTPS etc.
+ * Then the proxy can send X-Forward headers (X-Forwarded-Proto) that influences the host names in the OpenAPI schema
+ * that camel-openapi-java generates from Rest DSL routes.
*/
public RestConfigurationDefinition useXForwardHeaders(boolean useXForwardHeaders) {
setUseXForwardHeaders(useXForwardHeaders ? "true" : "false");
@@ -882,7 +888,11 @@ public class RestConfigurationDefinition {
}
/**
- * To specify whether to use X-Forward headers for Host and related setting
+ * Whether to use X-Forward headers to set host etc. for OpenApi.
+ *
+ * This may be needed in special cases involving reverse-proxy and networking going from HTTP to HTTPS etc.
+ * Then the proxy can send X-Forward headers (X-Forwarded-Proto) that influences the host names in the OpenAPI schema
+ * that camel-openapi-java generates from Rest DSL routes.
*/
public RestConfigurationDefinition useXForwardHeaders(String useXForwardHeaders) {
setUseXForwardHeaders(useXForwardHeaders);
diff --git a/core/camel-main/src/generated/resources/META-INF/camel-main-configuration-metadata.json b/core/camel-main/src/generated/resources/META-INF/camel-main-configuration-metadata.json
index 1f763aafe27..2c8368e3122 100644
--- a/core/camel-main/src/generated/resources/META-INF/camel-main-configuration-metadata.json
+++ b/core/camel-main/src/generated/resources/META-INF/camel-main-configuration-metadata.json
@@ -233,7 +233,7 @@
{ "name": "camel.rest.producerComponent", "description": "Sets the name of the Camel component to use as the REST producer", "sourceType": "org.apache.camel.spi.RestConfiguration", "type": "string", "javaType": "java.lang.String" },
{ "name": "camel.rest.scheme", "description": "Sets the scheme to use by the REST consumer", "sourceType": "org.apache.camel.spi.RestConfiguration", "type": "string", "javaType": "java.lang.String" },
{ "name": "camel.rest.skipBindingOnErrorCode", "description": "Whether to skip binding output if there is a custom HTTP error code, and instead use the response body as-is. This option is default true.", "sourceType": "org.apache.camel.spi.RestConfiguration", "type": "boolean", "javaType": "boolean", "defaultValue": true },
- { "name": "camel.rest.useXForwardHeaders", "description": "Whether to use X-Forward headers to set host etc. for Swagger. This option is default true.", "sourceType": "org.apache.camel.spi.RestConfiguration", "type": "boolean", "javaType": "boolean", "defaultValue": true },
+ { "name": "camel.rest.useXForwardHeaders", "description": "Whether to use X-Forward headers to set host etc. for OpenApi. This may be needed in special cases involving reverse-proxy and networking going from HTTP to HTTPS etc. Then the proxy can send X-Forward headers (X-Forwarded-Proto) that influences the host names in the OpenAPI schema that camel-openapi-java generates from Rest DSL routes.", "sourceType": "org.apache.camel.spi.RestConfiguration", "type": "boolean", "javaType": " [...]
{ "name": "camel.rest.xmlDataFormat", "description": "Sets a custom xml data format to be used. Important: This option is only for setting a custom name of the data format, not to refer to an existing data format instance.", "sourceType": "org.apache.camel.spi.RestConfiguration", "type": "string", "javaType": "java.lang.String" },
{ "name": "camel.routecontroller.backOffDelay", "description": "Backoff delay in millis when restarting a route that failed to startup.", "sourceType": "org.apache.camel.main.RouteControllerConfigurationProperties", "type": "integer", "javaType": "long", "defaultValue": 2000 },
{ "name": "camel.routecontroller.backOffMaxAttempts", "description": "Backoff maximum number of attempts to restart a route that failed to startup. When this threshold has been exceeded then the controller will give up attempting to restart the route, and the route will remain as stopped.", "sourceType": "org.apache.camel.main.RouteControllerConfigurationProperties", "type": "integer", "javaType": "long" },
diff --git a/core/camel-main/src/main/docs/main.adoc b/core/camel-main/src/main/docs/main.adoc
index 3496e7c35c6..3274ceb9c04 100644
--- a/core/camel-main/src/main/docs/main.adoc
+++ b/core/camel-main/src/main/docs/main.adoc
@@ -312,7 +312,7 @@ The camel.rest supports 28 options, which are listed below.
| *camel.rest.producerComponent* | Sets the name of the Camel component to use as the REST producer | | String
| *camel.rest.scheme* | Sets the scheme to use by the REST consumer | | String
| *camel.rest.skipBindingOnError{zwsp}Code* | Whether to skip binding output if there is a custom HTTP error code, and instead use the response body as-is. This option is default true. | true | boolean
-| *camel.rest.useXForwardHeaders* | Whether to use X-Forward headers to set host etc. for Swagger. This option is default true. | true | boolean
+| *camel.rest.useXForwardHeaders* | Whether to use X-Forward headers to set host etc. for OpenApi. This may be needed in special cases involving reverse-proxy and networking going from HTTP to HTTPS etc. Then the proxy can send X-Forward headers (X-Forwarded-Proto) that influences the host names in the OpenAPI schema that camel-openapi-java generates from Rest DSL routes. | false | boolean
| *camel.rest.xmlDataFormat* | Sets a custom xml data format to be used. Important: This option is only for setting a custom name of the data format, not to refer to an existing data format instance. | | String
|===
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 82b3cf4aa97..f5a68216d64 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
@@ -113,9 +113,11 @@ public class RestConfigurationProperties extends RestConfiguration implements Bo
}
/**
- * Whether to use X-Forward headers for Host and related setting.
- * <p/>
- * The default value is true.
+ * Whether to use X-Forward headers to set host etc. for OpenApi.
+ *
+ * This may be needed in special cases involving reverse-proxy and networking going from HTTP to HTTPS etc.
+ * Then the proxy can send X-Forward headers (X-Forwarded-Proto) that influences the host names in the OpenAPI schema
+ * that camel-openapi-java generates from Rest DSL routes.
*/
public RestConfigurationProperties withUseXForwardHeaders(boolean useXForwardHeaders) {
setUseXForwardHeaders(useXForwardHeaders);
diff --git a/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_5.adoc b/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_5.adoc
index bdfe969ff7d..b2d733e1168 100644
--- a/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_5.adoc
+++ b/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_5.adoc
@@ -82,6 +82,8 @@ Routes startup (total:2)
Started demo (rest://post:helloapp)
----
+The `restConfiguration` has changed default value in the `useXForwardHeaders` option from `true` to `false`.
+Using X-Forward headers is only used in special use-cases such as involving reverse proxies.
=== Intercept EIP
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 68306931efa..35ceea6d200 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
@@ -13809,7 +13809,7 @@ public final class ModelDeserializers extends YamlDeserializerSupport {
@YamlProperty(name = "producerComponent", type = "enum:vertx-http,http,undertow,netty-http", description = "Sets the name of the Camel component to use as the REST producer", displayName = "Producer Component"),
@YamlProperty(name = "scheme", type = "string", description = "The scheme to use for exposing the REST service. Usually http or https is supported. The default value is http", displayName = "Scheme"),
@YamlProperty(name = "skipBindingOnErrorCode", type = "boolean", description = "Whether to skip binding on output if there is a custom HTTP error code header. This allows to build custom error messages that do not bind to json / xml etc, as success messages otherwise will do.", displayName = "Skip Binding On Error Code"),
- @YamlProperty(name = "useXForwardHeaders", type = "boolean", description = "Whether to use X-Forward headers for Host and related setting. The default value is true.", displayName = "Use XForward Headers"),
+ @YamlProperty(name = "useXForwardHeaders", type = "boolean", description = "Whether to use X-Forward headers to set host etc. for OpenApi. This may be needed in special cases involving reverse-proxy and networking going from HTTP to HTTPS etc. Then the proxy can send X-Forward headers (X-Forwarded-Proto) that influences the host names in the OpenAPI schema that camel-openapi-java generates from Rest DSL routes.", displayName = "Use XForward Headers"),
@YamlProperty(name = "xmlDataFormat", type = "string", description = "Name of specific XML data format to use. By default jaxb will be used. Important: This option is only for setting a custom name of the data format, not to refer to an existing data format instance.", displayName = "Xml Data Format")
}
)
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 3533326fdc1..66d9a4e77bd 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
@@ -15337,7 +15337,7 @@
"useXForwardHeaders" : {
"type" : "boolean",
"title" : "Use XForward Headers",
- "description" : "Whether to use X-Forward headers for Host and related setting. The default value is true."
+ "description" : "Whether to use X-Forward headers to set host etc. for OpenApi. This may be needed in special cases involving reverse-proxy and networking going from HTTP to HTTPS etc. Then the proxy can send X-Forward headers (X-Forwarded-Proto) that influences the host names in the OpenAPI schema that camel-openapi-java generates from Rest DSL routes."
},
"xmlDataFormat" : {
"type" : "string",