Skip to content

CAMEL-23610: Normalize YAML DSL in component documentation to canonical form#23512

Merged
davsclaus merged 1 commit into
mainfrom
CAMEL-23610-normalize-yaml-dsl-components
May 26, 2026
Merged

CAMEL-23610: Normalize YAML DSL in component documentation to canonical form#23512
davsclaus merged 1 commit into
mainfrom
CAMEL-23610-normalize-yaml-dsl-components

Conversation

@davsclaus
Copy link
Copy Markdown
Contributor

Summary

Follow-up to #23511 (EIP + user manual docs). Normalizes YAML DSL code blocks in 19 component documentation files from classic shorthand form to canonical (normalized) form, consistent with the canonical JSON schema introduced in CAMEL-22987.

Four shorthand patterns were normalized:

  1. Shorthand to:- to: "direct:foo" → expanded with nested uri: field (67 instances)
  2. Shorthand log:- log: "${body}" → expanded with nested message: field (125 instances)
  3. Inline simple: expression — wrapped with canonical expression: / simple: / expression: structure (110 instances)
  4. URI with inline query params — split into uri: + parameters: block (73 instances)
  5. Bare from: without route: wrapper — wrapped with - route: parent (19 instances)

Files changed (19):

Component Instances Patterns
camel-keycloak 254 all 5 patterns
camel-docling 57 to, log, simple
camel-langchain4j-embeddings 12 to
camel-dhis2 12 bare from, log, simple
camel-openai 9 log, simple
camel-langchain4j-embeddingstore 9 to, log, simple
camel-aws2-s3-vectors 7 bare from, log, to
camel-pgvector 6 to, simple
camel-azure-storage-blob 6 log, to, URI params
camel-kamelet 6 to, log, simple, bare from, URI params
camel-camunda 6 simple, URI params
camel-event 6 log
camel-kafka 2 to
camel-pqc 5 log, simple, to
camel-dfdl 4 bare from, log
camel-ocsf 3 simple
camel-smooks (component + dataformat) 4 bare from, to, URI params, log
camel-ibm-watsonx-ai 2 simple, URI params

Test plan

  • Spot-checked representative YAML blocks with camel validate yaml-dsl (MCP schema validation)
  • Documentation-only change — no code changes, no test impact

Claude Code on behalf of Claus Ibsen

Co-Authored-By: Claude Opus 4.6 noreply@anthropic.com

…canonical form

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown
Contributor

🌟 Thank you for your contribution to the Apache Camel project! 🌟
🤖 CI automation will test this PR automatically.

🐫 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 have access to the summary.

⚠️ Be careful when sharing logs. Review their contents before sharing them publicly.

@github-actions
Copy link
Copy Markdown
Contributor

🧪 CI tested the following changed modules:

  • components/camel-ai/camel-docling
  • components/camel-ai/camel-langchain4j-embeddings
  • components/camel-ai/camel-langchain4j-embeddingstore
  • components/camel-ai/camel-openai
  • components/camel-ai/camel-pgvector
  • components/camel-aws/camel-aws2-s3-vectors
  • components/camel-azure/camel-azure-storage-blob
  • components/camel-camunda
  • components/camel-dfdl
  • components/camel-dhis2/camel-dhis2-component
  • components/camel-event
  • components/camel-ibm/camel-ibm-watsonx-ai
  • components/camel-kafka
  • components/camel-kamelet
  • components/camel-keycloak
  • components/camel-ocsf
  • components/camel-pqc
  • components/camel-smooks

ℹ️ Dependent modules were not tested because the total number of affected modules exceeded the threshold (50). Use the test-dependents label to force testing all dependents.

⚠️ Some tests are disabled on GitHub Actions (@DisabledIfSystemProperty(named = "ci.env.name")) and require manual verification:

  • components/camel-ai/camel-docling: 6 test(s) disabled on GitHub Actions
  • components/camel-ai/camel-openai: 6 test(s) disabled on GitHub Actions
  • components/camel-kafka: 2 test(s) disabled on GitHub Actions
Build reactor — dependencies compiled but only changed modules were tested (18 modules)
  • Camel :: AI :: Docling
  • Camel :: AI :: LangChain4j :: Embedding
  • Camel :: AI :: LangChain4j :: EmbeddingStore
  • Camel :: AI :: OpenAI
  • Camel :: AI :: PGVector
  • Camel :: AWS2 S3 Vectors
  • Camel :: Azure :: Storage Blob
  • Camel :: Camunda
  • Camel :: DFDL
  • Camel :: DHIS2
  • Camel :: Event
  • Camel :: IBM :: watsonx.ai
  • Camel :: Kafka
  • Camel :: Kamelet
  • Camel :: Keycloak
  • Camel :: OCSF
  • Camel :: PQC
  • Camel :: Smooks :: Parent

⚙️ View full build and test results

Copy link
Copy Markdown
Contributor

@gnodet gnodet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Documentation-only change normalizing YAML DSL code blocks in 19 component documentation files to canonical form (wrapping with - route:, expanding shorthand to:/log:/simple:, splitting inline query params). Consistent with the canonical JSON schema work in CAMEL-22987. No code changes.

LGTM.

Claude Code on behalf of Guillaume Nodet

@davsclaus davsclaus merged commit 5f4a7cf into main May 26, 2026
7 checks passed
@davsclaus davsclaus deleted the CAMEL-23610-normalize-yaml-dsl-components branch May 26, 2026 05:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants