You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by "davsclaus (via GitHub)" <gi...@apache.org> on 2026/09/14 07:05:34 UTC

[PR] CAMEL-24713: user manual - fix the YAML examples that do not validate; camel-yaml-dsl - add delayer to route [camel]

davsclaus opened a new pull request, #26390:
URL: https://github.com/apache/camel/pull/26390

   Prerequisite for [CAMEL-24713](https://issues.apache.org/jira/browse/CAMEL-24713): before the `camel_catalog_sample` fallback (`eip-samples.json`) can be generated from the user-manual pages with the build failing on an invalid example, the examples have to validate. Running `YamlValidator` over every `[source,yaml]` block starting with `- ` in `docs/user-manual/modules/ROOT/pages` gave 203 blocks, 36 invalid. After this PR: 186 valid; the 17 left are the old-syntax blocks of the upgrade guides, `camel-4-migration-guide`, `camel-jbang-transforming`, `camel-report-maven-plugin` (an ellipsis) and the two Antora-config blocks of `release-guide-website` / `improving-the-documentation`, which are deliberately not Camel YAML and will be excluded by the mojo.
   
   ### Doc fixes (11 pages, 18 blocks)
   
   | Page | What was wrong |
   |---|---|
   | `oncompletion.adoc` (4) | route scoped `onCompletion` written as a step: YAML has no route scope, so the example now uses a `routeConfiguration` the route refers to, with a sentence saying so; `executorServiceRef` → `executorService` |
   | `error-handler.adoc` (2) | `steps` at route level; route scoped `onException` as a step (the Java example is global, so top-level) and `redeliveryPolicy` as a step |
   | `exception-advanced.adoc`, `exception-handling-patterns.adoc`, `try-catch-finally.adoc` (3) | `redeliveryPolicy` / `onWhen` are properties of `onException` / `doCatch`, not steps; `beanType` → `type` |
   | `transformer.adoc` (3), `validator.adoc` (1) | `inputType` is a route property, not a step; `endpointTransformer` has no `parameters`, they go on the `uri` |
   | `routes.adoc` | `jaxb` needs `contextPath` |
   | `rest-dsl-openapi.adoc` | `bindingMode: true` is not in the enum → `json` (matches the Java example) |
   | `route-template-bean-binding.adoc` (2) | a template bean needs `type` (required in the model) |
   | `virtual-threads.adoc` | `threads` has no `steps`; the `to` follows it |
   
   ### YAML DSL: route `delayer`
   
   `delay-interceptor.adoc` was right, but `RouteDefinitionDeserializer` never exposed the `delayer` attribute that `RouteDefinition` has (`route.json` index 12). Added as a `string` property like the other duration options, schema regenerated in `camel-yaml-dsl` and the `camel-catalog` mirror, covered in `RoutesTest`.
   
   Verified: `RoutesTest` and the `camel-yaml-dsl-validator` test suite (90 tests) pass; a re-run of the validator over the user manual gives 186 ok / 17 intentionally invalid.
   
   _Claude Code on behalf of davsclaus_
   
   🤖 Generated with [Claude Code](https://claude.com/claude-code)


-- 
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: commits-unsubscribe@camel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] CAMEL-24713: user manual - fix the YAML examples that do not validate; camel-yaml-dsl - add delayer to route [camel]

Posted by "davsclaus (via GitHub)" <gi...@apache.org>.
davsclaus commented on PR #26390:
URL: https://github.com/apache/camel/pull/26390#issuecomment-5660837835

   Fixed the prose line in the YAML tab of `oncompletion.adoc` to say `executorService` (the XML tab keeps `executorServiceRef`). Thanks.
   
   _Claude Code on behalf of davsclaus_


-- 
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: commits-unsubscribe@camel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] CAMEL-24713: user manual - fix the YAML examples that do not validate; camel-yaml-dsl - add delayer to route [camel]

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #26390:
URL: https://github.com/apache/camel/pull/26390#issuecomment-5660291453

   :star2: Thank you for your contribution to the Apache Camel project! :star2:
     :robot: CI automation will test this PR automatically.
   
     :camel: Apache Camel Committers, please review the following items:
   
     * First-time contributors **require MANUAL approval** for the GitHub Actions to run
     * You can use the command `/component-test (camel-)component-name1 (camel-)component-name2..` to request a test from the test bot although they are normally detected and executed by CI.
     * You can label PRs using `skip-tests` and `test-dependents` to fine-tune the checks executed by this PR.
     * Build and test logs are available in the summary page. **Only** [Apache Camel committers](https://camel.apache.org/community/team/#committers) have access to the summary.
     
     :warning: Be careful when sharing logs. Review their contents before sharing them publicly.


-- 
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: commits-unsubscribe@camel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] CAMEL-24713: user manual - fix the YAML examples that do not validate; camel-yaml-dsl - add delayer to route [camel]

Posted by "davsclaus (via GitHub)" <gi...@apache.org>.
davsclaus merged PR #26390:
URL: https://github.com/apache/camel/pull/26390


-- 
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: commits-unsubscribe@camel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] CAMEL-24713: user manual - fix the YAML examples that do not validate; camel-yaml-dsl - add delayer to route [camel]

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #26390:
URL: https://github.com/apache/camel/pull/26390#issuecomment-5660620703

   <!-- ci-tested-modules -->
   :test_tube: **CI tested the following changed modules:**
   
   - `catalog/camel-catalog`
   - `docs`
   - `dsl/camel-yaml-dsl/camel-yaml-dsl-deserializers`
   - `dsl/camel-yaml-dsl/camel-yaml-dsl`
   
   ---
   
   <details><summary>:microscope: Scalpel shadow comparison — Scalpel: 12 tested, 21 compile-only — current: 8 all tested</summary>
   
   [Maveniverse Scalpel](https://github.com/maveniverse/scalpel) detected **33 affected modules** (current approach: 8).
   
   <details><summary>:warning: Modules only in Scalpel (25)</summary>
   
   - `apache-camel`
   - `camel-catalog`
   - `camel-catalog-console`
   - `camel-catalog-maven`
   - `camel-catalog-suggest`
   - `camel-componentdsl`
   - `camel-endpointdsl`
   - `camel-endpointdsl-support`
   - `camel-itest`
   - `camel-jbang-core`
   - `camel-jbang-it`
   - `camel-jbang-main`
   - `camel-jbang-plugin-edit`
   - `camel-jbang-plugin-generate`
   - `camel-jbang-plugin-kubernetes`
   - `camel-jbang-plugin-test`
   - `camel-kamelet-main`
   - `camel-launcher`
   - `camel-report-maven-plugin`
   - `camel-route-parser`
   - `camel-yaml-dsl`
   - `camel-yaml-dsl-deserializers`
   - `camel-yaml-dsl-maven-plugin`
   - `coverage`
   - `docs`
   
   </details>
   
   **Skip-tests mode would test 12 modules** (4 direct + 8 downstream), **skip tests for 21** (generated code, meta-modules)
   
   <details><summary>Modules Scalpel would test (12)</summary>
   
   - `camel-catalog`
   - `camel-jbang-mcp`
   - `camel-jbang-plugin-mcp`
   - `camel-jbang-plugin-route-parser`
   - `camel-jbang-plugin-tui`
   - `camel-jbang-plugin-validate`
   - `camel-launcher-container`
   - `camel-yaml-dsl`
   - `camel-yaml-dsl-deserializers`
   - `camel-yaml-dsl-validator`
   - `camel-yaml-dsl-validator-maven-plugin`
   - `docs`
   
   </details>
   
   <details><summary>Modules with tests skipped (21)</summary>
   
   - `apache-camel`
   - `camel-catalog-console`
   - `camel-catalog-maven`
   - `camel-catalog-suggest`
   - `camel-componentdsl`
   - `camel-endpointdsl`
   - `camel-endpointdsl-support`
   - `camel-itest`
   - `camel-jbang-core`
   - `camel-jbang-it`
   - `camel-jbang-main`
   - `camel-jbang-plugin-edit`
   - `camel-jbang-plugin-generate`
   - `camel-jbang-plugin-kubernetes`
   - `camel-jbang-plugin-test`
   - `camel-kamelet-main`
   - `camel-launcher`
   - `camel-report-maven-plugin`
   - `camel-route-parser`
   - `camel-yaml-dsl-maven-plugin`
   - `coverage`
   
   </details>
   
   > :information_source: Shadow mode — Scalpel observes but does not affect test execution. [Learn more](https://github.com/maveniverse/scalpel)
   
   </details>
   
   <details><summary>All tested modules (33 modules, 4m 53s total)</summary>
   
   **Total reactor time:** 4m 53s
   
   | Module | Duration | Status |
   | --- | --- | --- |
   | Camel :: Launcher | 49.8s | SUCCESS |
   | Camel :: JBang :: MCP | 41.2s | SUCCESS |
   | Camel :: JBang :: Plugin :: TUI | 35.3s | SUCCESS |
   | Camel :: Catalog :: Camel Catalog | 28.4s | SUCCESS |
   | Camel :: Docs | 23.1s | SUCCESS |
   | Camel :: Component DSL | 20.7s | SUCCESS |
   | Camel :: JBang :: Plugin :: Kubernetes | 16.9s | SUCCESS |
   | Camel :: Catalog :: Camel Report Maven Plugin | 9.5s | SUCCESS |
   | Camel :: Catalog :: Camel Route Parser | 9.4s | SUCCESS |
   | Camel :: JBang :: Plugin :: Testing | 9.1s | SUCCESS |
   | Camel :: YAML DSL :: Validator | 7.4s | SUCCESS |
   | Camel :: YAML DSL :: Deserializers | 7.2s | SUCCESS |
   | Camel :: Kamelet Main | 6.2s | SUCCESS |
   | Camel :: YAML DSL :: Maven Plugins | 5.7s | SUCCESS |
   | Camel :: Catalog :: Maven | 3.3s | SUCCESS |
   | Camel :: YAML DSL :: Validator Maven Plugin | 3.3s | SUCCESS |
   | Camel :: Catalog :: Suggest (deprecated) | 2.5s | SUCCESS |
   | Camel :: Catalog :: Console | 2.1s | SUCCESS |
   | Camel :: Assembly | 1.9s | SUCCESS |
   | Camel :: Coverage | 1.4s | SUCCESS |
   | Camel :: JBang :: Integration tests | 1.3s | SUCCESS |
   | Camel :: JBang :: Plugin :: Edit | 1.2s | SUCCESS |
   | Camel :: JBang :: Plugin :: Generate | 1.2s | SUCCESS |
   | Camel :: JBang :: Plugin :: Validate | 0.9s | SUCCESS |
   | Camel :: Endpoint DSL :: Support | 0.8s | SUCCESS |
   | Camel :: JBang :: Main | 0.8s | SUCCESS |
   | Camel :: Launcher :: Container | 0.7s | SUCCESS |
   | Camel :: JBang :: Plugin :: MCP | 0.6s | SUCCESS |
   | Camel :: JBang :: Plugin :: Route Parser | 0.5s | SUCCESS |
   | Camel :: Endpoint DSL | n/a |  |
   | Camel :: Integration Tests | n/a |  |
   | Camel :: JBang :: Core | n/a |  |
   | Camel :: YAML DSL | n/a |  |
   
   **Top 20 slowest modules:**
   - `Camel :: Launcher` (49.8s)
   - `Camel :: JBang :: MCP` (41.2s)
   - `Camel :: JBang :: Plugin :: TUI` (35.3s)
   - `Camel :: Catalog :: Camel Catalog` (28.4s)
   - `Camel :: Docs` (23.1s)
   - `Camel :: Component DSL` (20.7s)
   - `Camel :: JBang :: Plugin :: Kubernetes` (16.9s)
   - `Camel :: Catalog :: Camel Report Maven Plugin` (9.5s)
   - `Camel :: Catalog :: Camel Route Parser` (9.4s)
   - `Camel :: JBang :: Plugin :: Testing` (9.1s)
   - `Camel :: YAML DSL :: Validator` (7.4s)
   - `Camel :: YAML DSL :: Deserializers` (7.2s)
   - `Camel :: Kamelet Main` (6.2s)
   - `Camel :: YAML DSL :: Maven Plugins` (5.7s)
   - `Camel :: Catalog :: Maven` (3.3s)
   - `Camel :: YAML DSL :: Validator Maven Plugin` (3.3s)
   - `Camel :: Catalog :: Suggest (deprecated)` (2.5s)
   - `Camel :: Catalog :: Console` (2.1s)
   - `Camel :: Assembly` (1.9s)
   - `Camel :: Coverage` (1.4s)
   
   </details>
   
   ---
   :gear: [View full build and test results](https://github.com/apache/camel/actions/runs/34816238949)


-- 
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: commits-unsubscribe@camel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org