Claus Ibsen created CAMEL-25774:
-----------------------------------

             Summary: EIP docs - every route example in tabs with Java, XML and 
YAML, and an example for the idempotent consumer
                 Key: CAMEL-25774
                 URL: https://issues.apache.org/jira/browse/CAMEL-25774
             Project: Camel
          Issue Type: Improvement
          Components: documentation, camel-jbang
            Reporter: Claus Ibsen
            Assignee: Claus Ibsen
             Fix For: 4.24.0


The EIP pages should show every route example in tabs with Java, XML and YAML. 
A check of the 80 EIP pages on main found that 44 do. The rest have gaps:

* *idempotentConsumer has no example at all*, in any DSL. Its Example section 
says only "For example, see the above implementations for more details."
* *pausable, resumable and tokenizer* have tabs with Java only.
* *About 48 route examples sit outside tabs*, in Java or XML only, in 20 pages. 
The most are in cache (7), aggregate (4), choice (4), recipientList (3) and toD 
(3). The pattern pages resume-strategies (8), polling-consumer (2) and 
transactional-client (tabs with Spring XML only) have the same gap.
* *loadBalance, onFallback, resilience4jConfiguration, 
faultToleranceConfiguration, batchConfig and streamConfig* have no examples of 
their own. Their examples are on the load balancer policy pages, the circuit 
breaker pages and the resequence page, but the AI tools' sample lookup 
({{camel_catalog_sample}}) answers "no sample" for them.

The gaps hurt the AI tools: {{camel_catalog_sample}} reads the YAML examples of 
the docs. In a benchmark of Oct 18-19 2026 (a local model building an 
enrich-and-dedupe example), the step that adds an idempotent consumer passed 1 
of 6 times. The model asked {{camel_catalog_sample idempotentConsumer}} up to 
three times, got "no YAML sample", and guessed options that do not exist. In 
another example it looked for "the load-balance EIP sample with failover".

The plan:
# idempotentConsumer: an example in Java, XML and YAML with an in-memory 
repository, and one that logs the duplicates (skipDuplicate false and the 
CamelDuplicateMessage property), checked with camel run.
# pausable, resumable and tokenizer: XML and YAML tabs next to the Java ones.
# The route examples outside tabs go into tabs with Java, XML and YAML. Every 
YAML block is validated, and the examples are run where they can run on their 
own.
# camel_catalog_sample reads the related page for loadBalance (the policy 
pages), onFallback, resilience4jConfiguration and faultToleranceConfiguration 
(the circuit breaker pages), and batchConfig and streamConfig (the resequence 
page), as it does for interceptFrom since CAMEL-25735.

_Claude Code on behalf of davsclaus_



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

Reply via email to