This is an automated email from the ASF dual-hosted git repository.
oscerd pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel-spring-boot.git
The following commit(s) were added to refs/heads/main by this push:
new eef5d1007b8 [create-pull-request] automated change (#2064)
eef5d1007b8 is described below
commit eef5d1007b80d001736810ccc8e00bebcd484381
Author: github-actions[bot]
<41898282+github-actions[bot]@users.noreply.github.com>
AuthorDate: Fri Oct 30 06:33:17 2026 +0100
[create-pull-request] automated change (#2064)
Co-authored-by: oscerd <[email protected]>
---
.../springboot/catalog/components/rest-openapi.json | 8 +++++---
.../src/main/docs/rest-openapi.json | 7 +++++++
.../springboot/RestOpenApiComponentConfiguration.java | 16 ++++++++++++++++
.../modules/ROOT/pages/starters/rest-openapi.adoc | 3 ++-
4 files changed, 30 insertions(+), 4 deletions(-)
diff --git
a/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components/rest-openapi.json
b/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components/rest-openapi.json
index 8a27411a040..5b4fdfb89de 100644
---
a/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components/rest-openapi.json
+++
b/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components/rest-openapi.json
@@ -43,8 +43,9 @@
"consumes": { "index": 16, "kind": "property", "displayName": "Consumes",
"group": "producer (advanced)", "label": "producer,advanced", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "description": "What payload type this
component capable of consuming. Could be one type, like application\/json or
multiple types as application\/json, application\/xml; q=0.5 according to the
RFC7231. This equates to the va [...]
"produces": { "index": 17, "kind": "property", "displayName": "Produces",
"group": "producer (advanced)", "label": "producer,advanced", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "description": "What payload type this
component is producing. For example application\/json according to the RFC7231.
This equates to the value of Content-Type HTTP header. If set overrides any
value present in the OpenApi s [...]
"autowiredEnabled": { "index": 18, "kind": "property", "displayName":
"Autowired Enabled", "group": "advanced", "label": "advanced", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": true, "description":
"Whether autowiring is enabled. This is used for automatic autowiring options
(the option must be marked as autowired) by looking up in the registry to find
if there is a single instance of matching [...]
- "sslContextParameters": { "index": 19, "kind": "property", "displayName":
"Ssl Context Parameters", "group": "security", "label": "security", "required":
false, "type": "object", "javaType":
"org.apache.camel.support.jsse.SSLContextParameters", "deprecated": false,
"autowired": false, "secret": false, "description": "Customize TLS parameters
used by the component. If not set defaults to the TLS parameters set in the
Camel context" },
- "useGlobalSslContextParameters": { "index": 20, "kind": "property",
"displayName": "Use Global Ssl Context Parameters", "group": "security",
"label": "security", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "description": "Enable usage of global SSL context
parameters." }
+ "externalReferences": { "index": 19, "kind": "property", "displayName":
"External References", "group": "security", "label": "security", "required":
false, "type": "enum", "javaType": "java.lang.String", "enum": [ "all",
"local", "none" ], "deprecated": false, "autowired": false, "secret": false,
"defaultValue": "all", "description": "Which external references ($ref) the
OpenAPI specification may use: all allows any reference, local allows
references to the classpath and the file sys [...]
+ "sslContextParameters": { "index": 20, "kind": "property", "displayName":
"Ssl Context Parameters", "group": "security", "label": "security", "required":
false, "type": "object", "javaType":
"org.apache.camel.support.jsse.SSLContextParameters", "deprecated": false,
"autowired": false, "secret": false, "description": "Customize TLS parameters
used by the component. If not set defaults to the TLS parameters set in the
Camel context" },
+ "useGlobalSslContextParameters": { "index": 21, "kind": "property",
"displayName": "Use Global Ssl Context Parameters", "group": "security",
"label": "security", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "description": "Enable usage of global SSL context
parameters." }
},
"bodyTypes": {
"consumerOut": { "carriers": [ "stream", "bytes", "null", "map", "file" ],
"dependsOn": [ "consumerComponentName" ], "description": "The request body as
the HTTP consumer gives it (platform-http by default). With the json binding
mode of the rest configuration, the object of the schema (bindingPackageScan),
or a Map or a List" },
@@ -73,6 +74,7 @@
"requestValidationEnabled": { "index": 17, "kind": "parameter",
"displayName": "Request Validation Enabled", "group": "producer", "label":
"producer", "required": false, "type": "boolean", "javaType": "boolean",
"deprecated": false, "autowired": false, "secret": false, "defaultValue":
false, "description": "Enable validation of requests against the configured
OpenAPI specification" },
"componentName": { "index": 18, "kind": "parameter", "displayName":
"Component Name", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "description": "Name
of the Camel component that will perform the requests. The component must be
present in Camel registry and it must implement RestProducerFactory service
provider interface. If not set CLASSPAT [...]
"lazyStartProducer": { "index": 19, "kind": "parameter", "displayName":
"Lazy Start Producer", "group": "producer (advanced)", "label":
"producer,advanced", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "description": "Whether the producer should be started
lazy (on the first message). By starting lazy you can use this to allow
CamelContext and routes to startup in situations where a produ [...]
- "oauthProfile": { "index": 20, "kind": "parameter", "displayName": "OAuth
Profile", "group": "security", "label": "consumer,security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "description": "OAuth profile name passed
to the HTTP consumer delegate for validating incoming Authorization: Bearer
tokens. The selected consumer component must support the oauthProfile option;
delegates that ignore unknown [...]
+ "externalReferences": { "index": 20, "kind": "parameter", "displayName":
"External References", "group": "security", "label": "security", "required":
false, "type": "enum", "javaType": "java.lang.String", "enum": [ "all",
"local", "none" ], "deprecated": false, "autowired": false, "secret": false,
"defaultValue": "all", "description": "Which external references ($ref) the
OpenAPI specification may use. The parser loads every external reference when
the consumer or producer is created [...]
+ "oauthProfile": { "index": 21, "kind": "parameter", "displayName": "OAuth
Profile", "group": "security", "label": "consumer,security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "description": "OAuth profile name passed
to the HTTP consumer delegate for validating incoming Authorization: Bearer
tokens. The selected consumer component must support the oauthProfile option;
delegates that ignore unknown [...]
}
}
diff --git
a/components-starter/camel-rest-openapi-starter/src/main/docs/rest-openapi.json
b/components-starter/camel-rest-openapi-starter/src/main/docs/rest-openapi.json
index c874a44b152..97e755aa47d 100644
---
a/components-starter/camel-rest-openapi-starter/src/main/docs/rest-openapi.json
+++
b/components-starter/camel-rest-openapi-starter/src/main/docs/rest-openapi.json
@@ -88,6 +88,13 @@
"description": "Whether to enable auto configuration of the rest-openapi
component. This is enabled by default.",
"sourceType":
"org.apache.camel.component.rest.openapi.springboot.RestOpenApiComponentConfiguration"
},
+ {
+ "name": "camel.component.rest-openapi.external-references",
+ "type": "java.lang.String",
+ "description": "Which external references ($ref) the OpenAPI
specification may use: all allows any reference, local allows references to the
classpath and the file system only, and none allows only references inside the
document. A reference the option does not allow fails the start. Can be
overridden in endpoint configuration.",
+ "sourceType":
"org.apache.camel.component.rest.openapi.springboot.RestOpenApiComponentConfiguration",
+ "defaultValue": "all"
+ },
{
"name": "camel.component.rest-openapi.host",
"type": "java.lang.String",
diff --git
a/components-starter/camel-rest-openapi-starter/src/main/java/org/apache/camel/component/rest/openapi/springboot/RestOpenApiComponentConfiguration.java
b/components-starter/camel-rest-openapi-starter/src/main/java/org/apache/camel/component/rest/openapi/springboot/RestOpenApiComponentConfiguration.java
index 50cd3bb8b7d..de972cb905b 100644
---
a/components-starter/camel-rest-openapi-starter/src/main/java/org/apache/camel/component/rest/openapi/springboot/RestOpenApiComponentConfiguration.java
+++
b/components-starter/camel-rest-openapi-starter/src/main/java/org/apache/camel/component/rest/openapi/springboot/RestOpenApiComponentConfiguration.java
@@ -177,6 +177,14 @@ public class RestOpenApiComponentConfiguration
* etc.
*/
private Boolean autowiredEnabled = true;
+ /**
+ * Which external references ($ref) the OpenAPI specification may use: all
+ * allows any reference, local allows references to the classpath and the
+ * file system only, and none allows only references inside the document. A
+ * reference the option does not allow fails the start. Can be overridden
in
+ * endpoint configuration.
+ */
+ private String externalReferences = "all";
/**
* Customize TLS parameters used by the component. If not set defaults to
* the TLS parameters set in the Camel context. The option is a
@@ -341,6 +349,14 @@ public class RestOpenApiComponentConfiguration
this.autowiredEnabled = autowiredEnabled;
}
+ public String getExternalReferences() {
+ return externalReferences;
+ }
+
+ public void setExternalReferences(String externalReferences) {
+ this.externalReferences = externalReferences;
+ }
+
public SSLContextParameters getSslContextParameters() {
return sslContextParameters;
}
diff --git a/docs/spring-boot/modules/ROOT/pages/starters/rest-openapi.adoc
b/docs/spring-boot/modules/ROOT/pages/starters/rest-openapi.adoc
index ef37f9e1443..01a1dcb8b6f 100644
--- a/docs/spring-boot/modules/ROOT/pages/starters/rest-openapi.adoc
+++ b/docs/spring-boot/modules/ROOT/pages/starters/rest-openapi.adoc
@@ -23,7 +23,7 @@ Please refer to the above links for usage and configuration
details.
== Spring Boot Auto-Configuration
-The starter supports 22 options, which are listed below.
+The starter supports 23 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
@@ -39,6 +39,7 @@ The starter supports 22 options, which are listed below.
| camel.component.rest-openapi.consumer-component-name | Name of the Camel
component that will service the requests. The component must be present in
Camel registry and it must implement RestOpenApiConsumerFactory service
provider interface. If not set CLASSPATH is searched for single component that
implements RestOpenApiConsumerFactory SPI. Can be overridden in endpoint
configuration. | | String
| camel.component.rest-openapi.consumes | What payload type this component
capable of consuming. Could be one type, like application/json or multiple
types as application/json, application/xml; q=0.5 according to the RFC7231.
This equates to the value of Accept HTTP header. If set overrides any value
found in the OpenApi specification. Can be overridden in endpoint configuration
| | String
| camel.component.rest-openapi.enabled | Whether to enable auto configuration
of the rest-openapi component. This is enabled by default. | | Boolean
+| camel.component.rest-openapi.external-references | Which external references
($ref) the OpenAPI specification may use: all allows any reference, local
allows references to the classpath and the file system only, and none allows
only references inside the document. A reference the option does not allow
fails the start. Can be overridden in endpoint configuration. | all | String
| camel.component.rest-openapi.host | Scheme hostname and port to direct the
HTTP requests to in the form of https://hostname:port. Can be configured at the
endpoint, component or in the corresponding REST configuration in the Camel
Context. If you give this component a name (e.g. petstore) that REST
configuration is consulted first, rest-openapi next, and global configuration
last. If set overrides any value found in the OpenApi specification,
RestConfiguration. Can be overridden in end [...]
| camel.component.rest-openapi.lazy-start-producer | Whether the producer
should be started lazy (on the first message). By starting lazy you can use
this to allow CamelContext and routes to startup in situations where a producer
may otherwise fail during starting and cause the route to fail being started.
By deferring this startup to be lazy then the startup failure can be handled
during routing messages via Camel's routing error handlers. Beware that when
the first message is processed [...]
| camel.component.rest-openapi.missing-operation | Whether the consumer should
fail,ignore or return a mock response for OpenAPI operations that are not
mapped to a corresponding route. | fail | String
