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.git
The following commit(s) were added to refs/heads/main by this push:
new 1cd5c32368e5 CAMEL-23509: document 4.18.3 camel-lucene header rename
in upgrade guide
1cd5c32368e5 is described below
commit 1cd5c32368e5333f2f91663d6071dca8aae4e666
Author: Andrea Cosentino <[email protected]>
AuthorDate: Thu May 14 14:36:35 2026 +0200
CAMEL-23509: document 4.18.3 camel-lucene header rename in upgrade guide
Doc-sync companion to backport #23220 (camel-lucene header rename onto
camel-4.18.x).
Per the project's backport upgrade-guide policy, the
camel-4x-upgrade-guide-4_XX.adoc files live only on main and act as the
canonical history across all releases. This PR adds the camel-lucene
entry to camel-4x-upgrade-guide-4_18.adoc under the
"Upgrading from 4.18.1 to 4.18.3" section, documenting the rename of
the LuceneConstants Exchange header string values to the CamelLucene*
convention.
Closes #23222
---
.../modules/ROOT/pages/camel-4x-upgrade-guide-4_18.adoc | 17 +++++++++++++++++
1 file changed, 17 insertions(+)
diff --git
a/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_18.adoc
b/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_18.adoc
index 4e0d816d6af4..aa574409a18d 100644
--- a/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_18.adoc
+++ b/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_18.adoc
@@ -130,6 +130,23 @@ without changes. Routes that set the header by its literal
string value
(for example `setHeader("JGROUPS_DEST", ...)`) must be updated to use the
new value (`setHeader("CamelJGroupsDest", ...)`).
+=== camel-lucene
+
+The Exchange header values exposed by `LuceneConstants` have been renamed to
follow the standard
+Camel naming convention. The field names are unchanged, so routes referencing
the constants
+(`LuceneConstants.HEADER_QUERY`, `LuceneConstants.HEADER_RETURN_LUCENE_DOCS`)
continue to work
+without modification. However, routes that set or read these headers using the
raw string values
+must be updated:
+
+* `QUERY` -> `CamelLuceneQuery`
+* `RETURN_LUCENE_DOCS` -> `CamelLuceneReturnLuceneDocs`
+
+As a consequence, the generated Endpoint DSL header accessors on
`LuceneHeaderNameBuilder`
+have been renamed accordingly:
+
+* `qUERY()` -> `luceneQuery()`
+* `returnLuceneDocs()` -> `luceneReturnLuceneDocs()`
+
== Upgrading from 4.18.0 to 4.18.1
=== camel-bom
