Claus Ibsen created CAMEL-24710:
-----------------------------------
Summary: 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
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)
