Dhairya-007 opened a new pull request, #29570:
URL: https://github.com/apache/camel/pull/29570
Collected every `Camel*` header name written in a backtick, a string literal
or a `{@code ...}` tag under `components/*/src/main` and compared it against
the names the catalog actually declares. Four references name a header that
does not exist anywhere, so a user copying them sets a header the component
never reads — silently, with no error.
**camel-infinispan and camel-infinispan-embedded** (3 occurrences each) —
the "Optional Headers" lists for the PUT/PUTIFABSENT/REPLACE operations offer
```
** `CamelInfinispanLifespanTime`
** `CamelInfinispanLifespanTimeUnit`
** `CamelInfinispanMaxIdleTime`
** `CamelInfinispanMaxIdleTimeUnit`
```
There is no `CamelInfinispanLifespanTimeUnit`. The unit that goes with the
lifespan is `CamelInfinispanTimeUnit`, whose own description is "The Time Unit
of an entry Lifespan Time." (`CamelInfinispanMaxIdleTimeUnit` is the max-idle
counterpart and is spelled correctly here.) Setting the documented name leaves
the lifespan unit at its default, so a `lifespanTime` of 5 is interpreted in
the wrong unit.
**camel-keycloak** — the `resetUserPassword` example sets
`CamelKeycloakUserPasswordTemporary`; the declared header is
`CamelKeycloakPasswordTemporary` ("Whether the password is temporary"). The
neighbouring `CamelKeycloakUserPassword` in the same snippet is correct, which
is likely where the extra `User` came from. As written, the `false` is ignored.
**camel-langchain4j-embeddingstore** (2 javadoc occurrences) —
`LangChain4jEmbeddingStoreComponent`'s usage example and
`LangChain4jEmbeddingStoreProducer`'s SIMILARITY_SEARCH header list both name
`CamelLangchain4jEmbeddingEmbedding`. The producer reads
`LangChain4jEmbeddingsHeaders.EMBEDDING`, i.e.
`CamelLangChain4jEmbeddingsEmbedding`, which the same producer's javadoc spells
correctly 200 lines earlier:
```java
Embedding embedding = in.getHeader(LangChain4jEmbeddingsHeaders.EMBEDDING,
Embedding.class);
```
Both the capitalisation (`LangChain4j`) and the `Embeddings` segment were
wrong, so the example's `setHeader` is a no-op and the search falls through to
the auto-embedding path or fails with `NoSuchHeaderException`.
Checked and deliberately left alone: `CamelSolrField`/`CamelSolrParam` in
the solr docs (documented multiValue prefixes, used as
`CamelSolrField.<name>`), and the `CamelLangchain4jEmbeddingStore*` names,
which really are declared with that casing even though the sibling embeddings
component uses `LangChain4j`.
The three `.adoc` edits are mirrored into `catalog/camel-catalog/.../docs/`;
those copies were byte-identical to the component docs before this change and
are again afterwards. Docs and javadoc only, no behaviour change, no generated
metadata affected.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
