This is an automated email from the ASF dual-hosted git repository.
davsclaus 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 5de82a931660 camel-docling: mark the apiKeyHeader option as deprecated
(it is never used) (#29591)
5de82a931660 is described below
commit 5de82a93166083535afd10969e46b3eabcd2a4de
Author: WMK666666 <[email protected]>
AuthorDate: Thu Nov 12 14:32:39 2026 +0800
camel-docling: mark the apiKeyHeader option as deprecated (it is never
used) (#29591)
camel-docling: deprecate the apiKeyHeader option, which never had any effect
The docling-serve client sends the API key in the X-Api-Key header, the
name is
fixed in the client, and the producer never read the option: a user who set
apiKeyHeader got no warning and no effect, while the option sat in the
security
group of the endpoint.
Deprecate it with a note, as the camel-neo4j query option is deprecated,
and drop
it from the examples of the docling-serve page and from the tests, so nobody
copies a no-op. The catalog metadata and the two DSL builder factories
follow,
and the 4.24 upgrade guide gets the entry a deprecation takes.
The default value and the field initializer said X-API-Key while the
deprecation
note said X-Api-Key; both now say X-Api-Key, the spelling the client sends.
---
.../apache/camel/catalog/components/docling.json | 4 +-
.../apache/camel/catalog/docs/docling-serve.adoc | 48 +---------------------
.../apache/camel/component/docling/docling.json | 4 +-
.../camel-docling/src/main/docs/docling-serve.adoc | 48 +---------------------
.../component/docling/DoclingConfiguration.java | 18 +++++++-
.../ROOT/pages/camel-4x-upgrade-guide-4_24.adoc | 7 ++++
.../dsl/DoclingComponentBuilderFactory.java | 7 +++-
.../dsl/DoclingEndpointBuilderFactory.java | 21 +++++++---
8 files changed, 51 insertions(+), 106 deletions(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/docling.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/docling.json
index b970c5e3682a..9220ecae9be9 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/docling.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/docling.json
@@ -75,7 +75,7 @@
"includeRawMetadata": { "index": 48, "kind": "property", "displayName":
"Include Raw Metadata", "group": "metadata", "label": "metadata", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false,
"configurationClass":
"org.apache.camel.component.docling.DoclingConfiguration",
"configurationField": "configuration", "description": "Include raw metadata as
returned by the parser" },
"allowFilePathSource": { "index": 49, "kind": "property", "displayName":
"Allow File Path Source", "group": "security", "label": "security", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "security": "insecure:dev",
"defaultValue": false, "configurationClass":
"org.apache.camel.component.docling.DoclingConfiguration",
"configurationField": "configuration", "description": "Whether a String message
body that starts [...]
"allowUrlSource": { "index": 50, "kind": "property", "displayName": "Allow
Url Source", "group": "security", "label": "security", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "security": "insecure:dev", "defaultValue": false,
"configurationClass":
"org.apache.camel.component.docling.DoclingConfiguration",
"configurationField": "configuration", "description": "Whether a String message
body that starts with http: [...]
- "apiKeyHeader": { "index": 51, "kind": "property", "displayName": "Api Key
Header", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": "X-API-Key", "configurationClass":
"org.apache.camel.component.docling.DoclingConfiguration",
"configurationField": "configuration", "description": "Header name for API key
authentication" },
+ "apiKeyHeader": { "index": 51, "kind": "property", "displayName": "Api Key
Header", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": true,
"deprecationNote": "Not used: the docling-serve client always sends the API key
in the X-Api-Key header", "autowired": false, "secret": false, "defaultValue":
"X-Api-Key", "configurationClass":
"org.apache.camel.component.docling.DoclingConfiguration", "configurationField"
[...]
"authenticationScheme": { "index": 52, "kind": "property", "displayName":
"Authentication Scheme", "group": "security", "label": "security", "required":
false, "type": "enum", "javaType":
"org.apache.camel.component.docling.AuthenticationScheme", "enum": [ "NONE",
"BEARER", "API_KEY" ], "deprecated": false, "autowired": false, "secret":
false, "defaultValue": "NONE", "configurationClass":
"org.apache.camel.component.docling.DoclingConfiguration",
"configurationField": "configuration" [...]
"authenticationToken": { "index": 53, "kind": "property", "displayName":
"Authentication Token", "group": "security", "label": "security", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "security": "secret", "configurationClass":
"org.apache.camel.component.docling.DoclingConfiguration",
"configurationField": "configuration", "description": "Authentication token for
docling-serve API (Bearer token or API key)" },
"inputBaseDirectory": { "index": 54, "kind": "property", "displayName":
"Input Base Directory", "group": "security", "label": "security", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.docling.DoclingConfiguration",
"configurationField": "configuration", "description": "When set, every local
input file path must resolve inside this directory once normalize [...]
@@ -195,7 +195,7 @@
"useFixedDelay": { "index": 65, "kind": "parameter", "displayName": "Use
Fixed Delay", "group": "scheduler", "label": "consumer,scheduler", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": true, "description":
"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in
JDK for details." },
"allowFilePathSource": { "index": 66, "kind": "parameter", "displayName":
"Allow File Path Source", "group": "security", "label": "security", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "security": "insecure:dev",
"defaultValue": false, "configurationClass":
"org.apache.camel.component.docling.DoclingConfiguration",
"configurationField": "configuration", "description": "Whether a String message
body that start [...]
"allowUrlSource": { "index": 67, "kind": "parameter", "displayName":
"Allow Url Source", "group": "security", "label": "security", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "security": "insecure:dev",
"defaultValue": false, "configurationClass":
"org.apache.camel.component.docling.DoclingConfiguration",
"configurationField": "configuration", "description": "Whether a String message
body that starts with http [...]
- "apiKeyHeader": { "index": 68, "kind": "parameter", "displayName": "Api
Key Header", "group": "security", "label": "security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "X-API-Key",
"configurationClass":
"org.apache.camel.component.docling.DoclingConfiguration",
"configurationField": "configuration", "description": "Header name for API key
authentication" },
+ "apiKeyHeader": { "index": 68, "kind": "parameter", "displayName": "Api
Key Header", "group": "security", "label": "security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": true,
"deprecationNote": "Not used: the docling-serve client always sends the API key
in the X-Api-Key header", "autowired": false, "secret": false, "defaultValue":
"X-Api-Key", "configurationClass":
"org.apache.camel.component.docling.DoclingConfiguration", "configurationField
[...]
"authenticationScheme": { "index": 69, "kind": "parameter", "displayName":
"Authentication Scheme", "group": "security", "label": "security", "required":
false, "type": "enum", "javaType":
"org.apache.camel.component.docling.AuthenticationScheme", "enum": [ "NONE",
"BEARER", "API_KEY" ], "deprecated": false, "autowired": false, "secret":
false, "defaultValue": "NONE", "configurationClass":
"org.apache.camel.component.docling.DoclingConfiguration",
"configurationField": "configuration [...]
"authenticationToken": { "index": 70, "kind": "parameter", "displayName":
"Authentication Token", "group": "security", "label": "security", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "security": "secret", "configurationClass":
"org.apache.camel.component.docling.DoclingConfiguration",
"configurationField": "configuration", "description": "Authentication token for
docling-serve API (Bearer token or API [...]
"inputBaseDirectory": { "index": 71, "kind": "parameter", "displayName":
"Input Base Directory", "group": "security", "label": "security", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.docling.DoclingConfiguration",
"configurationField": "configuration", "description": "When set, every local
input file path must resolve inside this directory once normaliz [...]
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/docling-serve.adoc
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/docling-serve.adoc
index ae2e15c94c94..09c631fd5119 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/docling-serve.adoc
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/docling-serve.adoc
@@ -175,7 +175,6 @@ from("file:///data/documents?include=.*\\.pdf")
"doclingServeUrl=http://localhost:5001&"; +
"authenticationScheme=API_KEY&" +
"authenticationToken=your-api-key-here&" +
- "apiKeyHeader=X-API-Key&" +
"contentInBody=true")
.to("file:///data/output");
----
@@ -197,57 +196,14 @@ YAML::
doclingServeUrl: "http://localhost:5001";
authenticationScheme: "API_KEY"
authenticationToken: "your-api-key-here"
- apiKeyHeader: "X-API-Key"
contentInBody: true
- to:
uri: file:///data/output
----
====
-=== Using Custom API Key Header
-
-If your docling-serve instance uses a custom header name for API keys:
-
-[tabs]
-====
-Java::
-+
-[source,java]
-----
-from("file:///data/documents?include=.*\\.pdf")
- .to("docling:CONVERT_TO_MARKDOWN?" +
- "useDoclingServe=true&" +
- "doclingServeUrl=http://localhost:5001&"; +
- "authenticationScheme=API_KEY&" +
- "authenticationToken=your-api-key-here&" +
- "apiKeyHeader=X-Custom-API-Key&" +
- "contentInBody=true")
- .to("file:///data/output");
-----
-
-YAML::
-+
-[source,yaml]
-----
-- route:
- from:
- uri: file:///data/documents
- parameters:
- include: ".*\\.pdf"
- steps:
- - to:
- uri: docling:CONVERT_TO_MARKDOWN
- parameters:
- useDoclingServe: true
- doclingServeUrl: "http://localhost:5001";
- authenticationScheme: "API_KEY"
- authenticationToken: "your-api-key-here"
- apiKeyHeader: "X-Custom-API-Key"
- contentInBody: true
- - to:
- uri: file:///data/output
-----
-====
+The API key is always sent in the `X-Api-Key` header, which is the header the
docling-serve client uses.
+The `apiKeyHeader` option therefore has no effect and is deprecated.
=== Using Authentication Token from Properties
diff --git
a/components/camel-ai/camel-docling/src/generated/resources/META-INF/org/apache/camel/component/docling/docling.json
b/components/camel-ai/camel-docling/src/generated/resources/META-INF/org/apache/camel/component/docling/docling.json
index b970c5e3682a..9220ecae9be9 100644
---
a/components/camel-ai/camel-docling/src/generated/resources/META-INF/org/apache/camel/component/docling/docling.json
+++
b/components/camel-ai/camel-docling/src/generated/resources/META-INF/org/apache/camel/component/docling/docling.json
@@ -75,7 +75,7 @@
"includeRawMetadata": { "index": 48, "kind": "property", "displayName":
"Include Raw Metadata", "group": "metadata", "label": "metadata", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false,
"configurationClass":
"org.apache.camel.component.docling.DoclingConfiguration",
"configurationField": "configuration", "description": "Include raw metadata as
returned by the parser" },
"allowFilePathSource": { "index": 49, "kind": "property", "displayName":
"Allow File Path Source", "group": "security", "label": "security", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "security": "insecure:dev",
"defaultValue": false, "configurationClass":
"org.apache.camel.component.docling.DoclingConfiguration",
"configurationField": "configuration", "description": "Whether a String message
body that starts [...]
"allowUrlSource": { "index": 50, "kind": "property", "displayName": "Allow
Url Source", "group": "security", "label": "security", "required": false,
"type": "boolean", "javaType": "boolean", "deprecated": false, "autowired":
false, "secret": false, "security": "insecure:dev", "defaultValue": false,
"configurationClass":
"org.apache.camel.component.docling.DoclingConfiguration",
"configurationField": "configuration", "description": "Whether a String message
body that starts with http: [...]
- "apiKeyHeader": { "index": 51, "kind": "property", "displayName": "Api Key
Header", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": "X-API-Key", "configurationClass":
"org.apache.camel.component.docling.DoclingConfiguration",
"configurationField": "configuration", "description": "Header name for API key
authentication" },
+ "apiKeyHeader": { "index": 51, "kind": "property", "displayName": "Api Key
Header", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": true,
"deprecationNote": "Not used: the docling-serve client always sends the API key
in the X-Api-Key header", "autowired": false, "secret": false, "defaultValue":
"X-Api-Key", "configurationClass":
"org.apache.camel.component.docling.DoclingConfiguration", "configurationField"
[...]
"authenticationScheme": { "index": 52, "kind": "property", "displayName":
"Authentication Scheme", "group": "security", "label": "security", "required":
false, "type": "enum", "javaType":
"org.apache.camel.component.docling.AuthenticationScheme", "enum": [ "NONE",
"BEARER", "API_KEY" ], "deprecated": false, "autowired": false, "secret":
false, "defaultValue": "NONE", "configurationClass":
"org.apache.camel.component.docling.DoclingConfiguration",
"configurationField": "configuration" [...]
"authenticationToken": { "index": 53, "kind": "property", "displayName":
"Authentication Token", "group": "security", "label": "security", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "security": "secret", "configurationClass":
"org.apache.camel.component.docling.DoclingConfiguration",
"configurationField": "configuration", "description": "Authentication token for
docling-serve API (Bearer token or API key)" },
"inputBaseDirectory": { "index": 54, "kind": "property", "displayName":
"Input Base Directory", "group": "security", "label": "security", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.docling.DoclingConfiguration",
"configurationField": "configuration", "description": "When set, every local
input file path must resolve inside this directory once normalize [...]
@@ -195,7 +195,7 @@
"useFixedDelay": { "index": 65, "kind": "parameter", "displayName": "Use
Fixed Delay", "group": "scheduler", "label": "consumer,scheduler", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": true, "description":
"Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in
JDK for details." },
"allowFilePathSource": { "index": 66, "kind": "parameter", "displayName":
"Allow File Path Source", "group": "security", "label": "security", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "security": "insecure:dev",
"defaultValue": false, "configurationClass":
"org.apache.camel.component.docling.DoclingConfiguration",
"configurationField": "configuration", "description": "Whether a String message
body that start [...]
"allowUrlSource": { "index": 67, "kind": "parameter", "displayName":
"Allow Url Source", "group": "security", "label": "security", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "security": "insecure:dev",
"defaultValue": false, "configurationClass":
"org.apache.camel.component.docling.DoclingConfiguration",
"configurationField": "configuration", "description": "Whether a String message
body that starts with http [...]
- "apiKeyHeader": { "index": 68, "kind": "parameter", "displayName": "Api
Key Header", "group": "security", "label": "security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "X-API-Key",
"configurationClass":
"org.apache.camel.component.docling.DoclingConfiguration",
"configurationField": "configuration", "description": "Header name for API key
authentication" },
+ "apiKeyHeader": { "index": 68, "kind": "parameter", "displayName": "Api
Key Header", "group": "security", "label": "security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": true,
"deprecationNote": "Not used: the docling-serve client always sends the API key
in the X-Api-Key header", "autowired": false, "secret": false, "defaultValue":
"X-Api-Key", "configurationClass":
"org.apache.camel.component.docling.DoclingConfiguration", "configurationField
[...]
"authenticationScheme": { "index": 69, "kind": "parameter", "displayName":
"Authentication Scheme", "group": "security", "label": "security", "required":
false, "type": "enum", "javaType":
"org.apache.camel.component.docling.AuthenticationScheme", "enum": [ "NONE",
"BEARER", "API_KEY" ], "deprecated": false, "autowired": false, "secret":
false, "defaultValue": "NONE", "configurationClass":
"org.apache.camel.component.docling.DoclingConfiguration",
"configurationField": "configuration [...]
"authenticationToken": { "index": 70, "kind": "parameter", "displayName":
"Authentication Token", "group": "security", "label": "security", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "security": "secret", "configurationClass":
"org.apache.camel.component.docling.DoclingConfiguration",
"configurationField": "configuration", "description": "Authentication token for
docling-serve API (Bearer token or API [...]
"inputBaseDirectory": { "index": 71, "kind": "parameter", "displayName":
"Input Base Directory", "group": "security", "label": "security", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.docling.DoclingConfiguration",
"configurationField": "configuration", "description": "When set, every local
input file path must resolve inside this directory once normaliz [...]
diff --git a/components/camel-ai/camel-docling/src/main/docs/docling-serve.adoc
b/components/camel-ai/camel-docling/src/main/docs/docling-serve.adoc
index ae2e15c94c94..09c631fd5119 100644
--- a/components/camel-ai/camel-docling/src/main/docs/docling-serve.adoc
+++ b/components/camel-ai/camel-docling/src/main/docs/docling-serve.adoc
@@ -175,7 +175,6 @@ from("file:///data/documents?include=.*\\.pdf")
"doclingServeUrl=http://localhost:5001&"; +
"authenticationScheme=API_KEY&" +
"authenticationToken=your-api-key-here&" +
- "apiKeyHeader=X-API-Key&" +
"contentInBody=true")
.to("file:///data/output");
----
@@ -197,57 +196,14 @@ YAML::
doclingServeUrl: "http://localhost:5001";
authenticationScheme: "API_KEY"
authenticationToken: "your-api-key-here"
- apiKeyHeader: "X-API-Key"
contentInBody: true
- to:
uri: file:///data/output
----
====
-=== Using Custom API Key Header
-
-If your docling-serve instance uses a custom header name for API keys:
-
-[tabs]
-====
-Java::
-+
-[source,java]
-----
-from("file:///data/documents?include=.*\\.pdf")
- .to("docling:CONVERT_TO_MARKDOWN?" +
- "useDoclingServe=true&" +
- "doclingServeUrl=http://localhost:5001&"; +
- "authenticationScheme=API_KEY&" +
- "authenticationToken=your-api-key-here&" +
- "apiKeyHeader=X-Custom-API-Key&" +
- "contentInBody=true")
- .to("file:///data/output");
-----
-
-YAML::
-+
-[source,yaml]
-----
-- route:
- from:
- uri: file:///data/documents
- parameters:
- include: ".*\\.pdf"
- steps:
- - to:
- uri: docling:CONVERT_TO_MARKDOWN
- parameters:
- useDoclingServe: true
- doclingServeUrl: "http://localhost:5001";
- authenticationScheme: "API_KEY"
- authenticationToken: "your-api-key-here"
- apiKeyHeader: "X-Custom-API-Key"
- contentInBody: true
- - to:
- uri: file:///data/output
-----
-====
+The API key is always sent in the `X-Api-Key` header, which is the header the
docling-serve client uses.
+The `apiKeyHeader` option therefore has no effect and is deprecated.
=== Using Authentication Token from Properties
diff --git
a/components/camel-ai/camel-docling/src/main/java/org/apache/camel/component/docling/DoclingConfiguration.java
b/components/camel-ai/camel-docling/src/main/java/org/apache/camel/component/docling/DoclingConfiguration.java
index 4c9b6df1f799..cbd70eb54da8 100644
---
a/components/camel-ai/camel-docling/src/main/java/org/apache/camel/component/docling/DoclingConfiguration.java
+++
b/components/camel-ai/camel-docling/src/main/java/org/apache/camel/component/docling/DoclingConfiguration.java
@@ -128,8 +128,10 @@ public class DoclingConfiguration implements Cloneable {
private AuthenticationScheme authenticationScheme =
AuthenticationScheme.NONE;
@UriParam(label = "security")
- @Metadata(description = "Header name for API key authentication",
defaultValue = "X-API-Key")
- private String apiKeyHeader = "X-API-Key";
+ @Metadata(description = "Header name for API key authentication",
defaultValue = "X-Api-Key",
+ deprecationNote = "Not used: the docling-serve client always
sends the API key in the X-Api-Key header")
+ @Deprecated
+ private String apiKeyHeader = "X-Api-Key";
@UriParam(label = "advanced")
@Metadata(description = "Use asynchronous conversion mode (docling-serve
API only)", defaultValue = "false")
@@ -426,10 +428,22 @@ public class DoclingConfiguration implements Cloneable {
this.authenticationScheme = authenticationScheme;
}
+ /**
+ * Header name for API key authentication
+ *
+ * @deprecated not used: the docling-serve client always sends the API key
in the {@code X-Api-Key} header
+ */
+ @Deprecated
public String getApiKeyHeader() {
return apiKeyHeader;
}
+ /**
+ * Header name for API key authentication
+ *
+ * @deprecated not used: the docling-serve client always sends the API key
in the {@code X-Api-Key} header
+ */
+ @Deprecated
public void setApiKeyHeader(String apiKeyHeader) {
this.apiKeyHeader = apiKeyHeader;
}
diff --git
a/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_24.adoc
b/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_24.adoc
index 70478e671681..e53d680725de 100644
--- a/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_24.adoc
+++ b/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_24.adoc
@@ -8099,3 +8099,10 @@ A `java.time` value in a POJO body no longer fails:
`callFunction` of `camel-goo
Exceptions: `camel-huaweicloud-dms` and `camel-huaweicloud-iam` let a failure
to write a response as JSON through as the
unchecked `tools.jackson.core.JacksonException`, which is not an
`IOException`, so `onException(IOException.class)` does not
match it.
+
+=== camel-docling - the apiKeyHeader option is deprecated
+
+The `apiKeyHeader` option never had any effect: the name of the header that
carries the API key is fixed in the
+docling-serve client, which always sends it as `X-Api-Key`, and the producer
never read the option. It is now
+deprecated, with a `deprecationNote` that says so. Remove `apiKeyHeader` from
the endpoint URI or the configuration:
+with `authenticationScheme=API_KEY` and `authenticationToken` set, the key is
still sent, as `X-Api-Key`.
diff --git
a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/DoclingComponentBuilderFactory.java
b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/DoclingComponentBuilderFactory.java
index aa3fbef375c3..adcc1b513bbe 100644
---
a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/DoclingComponentBuilderFactory.java
+++
b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/DoclingComponentBuilderFactory.java
@@ -937,16 +937,19 @@ public interface DoclingComponentBuilderFactory {
/**
- * Header name for API key authentication.
+ * Header name for API key authentication. Deprecation note: Not used:
+ * the docling-serve client always sends the API key in the X-Api-Key
+ * header.
*
* The option is a: <code>java.lang.String</code> type.
*
- * Default: X-API-Key
+ * Default: X-Api-Key
* Group: security
*
* @param apiKeyHeader the value to set
* @return the dsl builder
*/
+ @Deprecated
default DoclingComponentBuilder apiKeyHeader(java.lang.String
apiKeyHeader) {
doSetProperty("apiKeyHeader", apiKeyHeader);
return this;
diff --git
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/DoclingEndpointBuilderFactory.java
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/DoclingEndpointBuilderFactory.java
index 731d2362de6a..cdf416663bb0 100644
---
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/DoclingEndpointBuilderFactory.java
+++
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/DoclingEndpointBuilderFactory.java
@@ -1169,16 +1169,19 @@ public interface DoclingEndpointBuilderFactory {
return this;
}
/**
- * Header name for API key authentication.
+ * Header name for API key authentication. Deprecation note: Not used:
+ * the docling-serve client always sends the API key in the X-Api-Key
+ * header.
*
* The option is a: <code>java.lang.String</code> type.
*
- * Default: X-API-Key
+ * Default: X-Api-Key
* Group: security
*
* @param apiKeyHeader the value to set
* @return the dsl builder
*/
+ @Deprecated
default DoclingEndpointConsumerBuilder apiKeyHeader(String
apiKeyHeader) {
doSetProperty("apiKeyHeader", apiKeyHeader);
return this;
@@ -2761,16 +2764,19 @@ public interface DoclingEndpointBuilderFactory {
return this;
}
/**
- * Header name for API key authentication.
+ * Header name for API key authentication. Deprecation note: Not used:
+ * the docling-serve client always sends the API key in the X-Api-Key
+ * header.
*
* The option is a: <code>java.lang.String</code> type.
*
- * Default: X-API-Key
+ * Default: X-Api-Key
* Group: security
*
* @param apiKeyHeader the value to set
* @return the dsl builder
*/
+ @Deprecated
default DoclingEndpointProducerBuilder apiKeyHeader(String
apiKeyHeader) {
doSetProperty("apiKeyHeader", apiKeyHeader);
return this;
@@ -4246,16 +4252,19 @@ public interface DoclingEndpointBuilderFactory {
return this;
}
/**
- * Header name for API key authentication.
+ * Header name for API key authentication. Deprecation note: Not used:
+ * the docling-serve client always sends the API key in the X-Api-Key
+ * header.
*
* The option is a: <code>java.lang.String</code> type.
*
- * Default: X-API-Key
+ * Default: X-Api-Key
* Group: security
*
* @param apiKeyHeader the value to set
* @return the dsl builder
*/
+ @Deprecated
default DoclingEndpointBuilder apiKeyHeader(String apiKeyHeader) {
doSetProperty("apiKeyHeader", apiKeyHeader);
return this;
