You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2026/08/06 05:27:30 UTC
(camel) 02/02: Regen
This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 3f8b94256f11f85a53a64092e2c80b0103c828ef
Author: Claus Ibsen <cl...@gmail.com>
AuthorDate: Thu Aug 6 07:27:17 2026 +0200
Regen
---
.../org/apache/camel/catalog/docs/yaml-dsl.adoc | 30 ++++++++++++++++++++++
1 file changed, 30 insertions(+)
diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/yaml-dsl.adoc b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/yaml-dsl.adoc
index 828ea2e286cd..6773f8a975c4 100644
--- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/yaml-dsl.adoc
+++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/yaml-dsl.adoc
@@ -257,6 +257,36 @@ This SPI is not a sandbox for processing untrusted YAML documents.
Resolver implementations should not fetch external resources, load classes named by route fields, or evaluate route
fields as expressions while parsing YAML.
+=== YAML DSL Model for Tooling
+
+The `camelYamlDsl-model.json` file is a generated data structure that describes the complete YAML DSL
+structural tree — every valid key at every nesting level, with types, descriptions, required flags,
+default values, enum choices, and references to child nodes. It is generated during the build from
+the canonical YAML DSL JSON schema and enriched with metadata from the Camel catalog (EIP models,
+expression languages, and data formats).
+
+The file is available on the classpath at `schema/camelYamlDsl-model.json` and can be used by
+third-party tooling such as editors, IDE plugins, and visual designers (e.g., Kaoto, Karavan)
+to provide context-aware code completion, validation, and documentation for YAML DSL routes.
+
+The model is organized as a flat map of node definitions under a top-level `nodes` object.
+Key nodes include:
+
+- `root` — the top-level YAML DSL elements (route, from, rest, beans, errorHandler, etc.)
+- `steps` — all valid EIP names that can appear inside a `steps` block
+- `expression` — all available expression language names (simple, jsonpath, xpath, etc.)
+- EIP nodes (e.g., `split`, `filter`, `setHeader`) — each EIP's options including attributes,
+ expression references, and nested steps
+- Language nodes (e.g., `simple`, `jsonpath`) — each language's configuration options
+- Data format nodes (e.g., `csv`, `avro`) — each data format's configuration options
+
+Each child entry in a node carries: `name`, `type`, `description`, `index` (display order),
+`group`, `label`, `required`, `default`, `enum`, `deprecated`, and optionally a `ref`
+pointing to a child node for nested structures.
+
+NOTE: Component endpoint parameters are not included in this file — those are available
+as individual JSON files in the `camel-catalog` module (e.g., `components/kafka.json`).
+
== Defining endpoints
To define an endpoint with the YAML dsl you have two options: