[
https://issues.apache.org/jira/browse/CAMEL-24710?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=18115898#comment-18115898
]
Claus Ibsen commented on CAMEL-24710:
-------------------------------------
What is still to do, measured on main on 2026-09-16:
*Done:* all four page families validate against the schema and the build guards
them (EipDocExamplesTest, PRs 26392, 26397, 26398, 26448). Schema failures
across the 1,820 YAML route examples: 0.
*Outstanding:* the ticket's measurement was schema _plus_ the catalog checks
(endpoint options, Simple, headers), and those had no build guard. Re-running
that measurement gave 87 failures on 28 pages:
* ~35 on the 7 components of CAMEL-24748 (PR 26451) — nothing to do here until
that lands.
* ~30 checker false positives (a comment after a value, a JSON block scalar
read as options, a nested map option, dotted header names, name: under
setProperty) and ~20 examples that were wrong or relied on missing header
metadata.
https://github.com/apache/camel/pull/26494 fixes the second and third groups,
adds the missing header metadata (crypto, solr, box), lets the catalog
validator accept {{option.key}} for Map options, and adds
*CatalogDocExamplesTest* in camel-jbang-core as the guard for the catalog
checks, with the CAMEL-24748 pages in an explicit skip list. It also found five
more metadata-vs-runtime mismatches (olingo2/4, xmpp, huggingface, salesforce
approval.*, jt400 syntax), reported on CAMEL-24748.
After 26494 and 26451: drop the pages from the skip list as the metadata is
fixed, then this ticket can close and CAMEL-24720 can start.
_Claude Code on behalf of davsclaus_
> docs - about 375 YAML route examples in the component and data format
> documentation do not validate
> ---------------------------------------------------------------------------------------------------
>
> Key: CAMEL-24710
> URL: https://issues.apache.org/jira/browse/CAMEL-24710
> Project: Camel
> Issue Type: Task
> Components: documentation
> Reporter: Claus Ibsen
> Assignee: Karol Krawczyk
> Priority: Major
> Fix For: 4.23.0
>
>
> Validating every [source,yaml] route example (blocks starting with "- ") in
> the documentation pages bundled in camel-catalog with the YAML validator
> (schema plus the catalog checks of endpoint options and Simple) on
> 2026-09-13, after CAMEL-24693, CAMEL-24694 and CAMEL-24697:
> ||Pages||YAML route examples||Failing||
> |EIP pages (-eip and the pattern pages)|290|0 (a build-time test guards them,
> CAMEL-24693)|
> |Component pages|1,225|270|
> |Component sub-pages (consumer/producer examples, *-examples)|205|74|
> |Data format pages|100|31|
> |Language pages|34|2 (validator false positives: jsonpath and xpath are not
> on the validator's classpath)|
> The recurring shapes in the failures are the ones a beginner writes, and a
> model copies:
> * {{from:}} without {{steps:}} (the steps written at the route level or
> missing)
> * a step written as a map property of the previous step ({{property 'to' is
> not defined}})
> * endpoint options that do not exist or are misspelled
> ({{idempotentStrategy}}), or the wrong enum value
> * data format options written with a wrong name or shape ({{ref}},
> {{autogenColumns}}, {{skipFirstLine}}, {{elementNameStrategyRef}})
> * a producer-only component used in {{from:}}
> * YAML that does not parse (a trailing comment on a value, ocsf-dataformat)
> Suggested approach: extend the EIP documentation test (EipDocExamplesTest in
> camel-yaml-dsl-validator) page family by page family once each family's
> examples are fixed, so the build keeps them right; the languages need the
> validator to skip languages it cannot load rather than report them.
> The script used to measure is a few lines: extract the blocks from the
> catalog's docs, validate each. The failing examples per page can be listed on
> request.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
