diff --git a/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_14.adoc b/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_14.adoc index 0e0e015b64d7f..0200cebc9e89e 100644 --- a/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_14.adoc +++ b/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_14.adoc @@ -515,6 +515,63 @@ A new accessor `web3jOperation()` is also generated for `Web3jConstants.OPERATIO previously, so no DSL accessor renaming applies to it. +=== camel-elasticsearch / camel-opensearch - potential breaking change + +The Exchange header constants in `ElasticsearchConstants` and +`OpensearchConstants` have been renamed to follow the Camel naming convention +used across the rest of the component catalog. The Java field names are +unchanged; only the header string values have changed. + +`ElasticsearchConstants`: + +[options="header"] +|=== +| Constant | Previous value | New value +| `ElasticsearchConstants.PARAM_OPERATION` | `operation` | `CamelElasticsearchOperation` +| `ElasticsearchConstants.PARAM_INDEX_ID` | `indexId` | `CamelElasticsearchIndexId` +| `ElasticsearchConstants.PARAM_INDEX_NAME` | `indexName` | `CamelElasticsearchIndexName` +| `ElasticsearchConstants.PARAM_DOCUMENT_CLASS` | `documentClass` | `CamelElasticsearchDocumentClass` +| `ElasticsearchConstants.PARAM_WAIT_FOR_ACTIVE_SHARDS` | `waitForActiveShards` | `CamelElasticsearchWaitForActiveShards` +| `ElasticsearchConstants.PARAM_SCROLL_KEEP_ALIVE_MS` | `scrollKeepAliveMs` | `CamelElasticsearchScrollKeepAliveMs` +| `ElasticsearchConstants.PARAM_SCROLL` | `useScroll` | `CamelElasticsearchUseScroll` +| `ElasticsearchConstants.PARAM_SIZE` | `size` | `CamelElasticsearchSize` +| `ElasticsearchConstants.PARAM_FROM` | `from` | `CamelElasticsearchFrom` +| `ElasticsearchConstants.PARAM_DOCUMENT_MODE` | `enableDocumentOnlyMode` | `CamelElasticsearchEnableDocumentOnlyMode` +|=== + +`OpensearchConstants`: + +[options="header"] +|=== +| Constant | Previous value | New value +| `OpensearchConstants.PARAM_OPERATION` | `operation` | `CamelOpensearchOperation` +| `OpensearchConstants.PARAM_INDEX_ID` | `indexId` | `CamelOpensearchIndexId` +| `OpensearchConstants.PARAM_INDEX_NAME` | `indexName` | `CamelOpensearchIndexName` +| `OpensearchConstants.PARAM_DOCUMENT_CLASS` | `documentClass` | `CamelOpensearchDocumentClass` +| `OpensearchConstants.PARAM_WAIT_FOR_ACTIVE_SHARDS` | `waitForActiveShards` | `CamelOpensearchWaitForActiveShards` +| `OpensearchConstants.PARAM_SCROLL_KEEP_ALIVE_MS` | `scrollKeepAliveMs` | `CamelOpensearchScrollKeepAliveMs` +| `OpensearchConstants.PARAM_SCROLL` | `useScroll` | `CamelOpensearchUseScroll` +| `OpensearchConstants.PARAM_SIZE` | `size` | `CamelOpensearchSize` +| `OpensearchConstants.PARAM_FROM` | `from` | `CamelOpensearchFrom` +|=== + +`ElasticsearchConstants.PROPERTY_SCROLL_ES_QUERY_COUNT` and +`OpensearchConstants.PROPERTY_SCROLL_OPENSEARCH_QUERY_COUNT` were already +`Camel`-prefixed (`CamelElasticsearchScrollQueryCount` / +`CamelOpenSearchScrollQueryCount`) and are unchanged. + +Routes that reference the constants symbolically (for example +`setHeader(ElasticsearchConstants.PARAM_INDEX_NAME, ...)`) continue to work +without changes. Routes that set the header by its literal string value +(for example `setHeader("indexName", ...)`) must be updated to use the +new value (`setHeader("CamelElasticsearchIndexName", ...)`). + +The generated Endpoint DSL header accessors on +`ElasticsearchHeaderNameBuilder` and `OpensearchHeaderNameBuilder` have +been renamed accordingly (`operation()` -> `elasticsearchOperation()` / +`opensearchOperation()`, `indexId()` -> `elasticsearchIndexId()` / +`opensearchIndexId()`, etc.). + === camel-google-functions / camel-google-secret-manager - potential breaking change The Exchange header constants in these Google Cloud components carried a