Skip to content

chore: add Exchange header naming conventions design document#23476

Merged
gnodet merged 3 commits into
apache:mainfrom
gnodet:quick-fix/header-naming-conventions
May 22, 2026
Merged

chore: add Exchange header naming conventions design document#23476
gnodet merged 3 commits into
apache:mainfrom
gnodet:quick-fix/header-naming-conventions

Conversation

@gnodet
Copy link
Copy Markdown
Contributor

@gnodet gnodet commented May 22, 2026

Summary

Add design/headers.adoc documenting the Exchange header naming convention that the ongoing alignment work (CAMEL-2357x/CAMEL-2359x by @oscerd) is enforcing.

Depends on #23447 (rename proposals/ to design/).

The convention document covers:

  • Naming rule: "Camel" + ComponentName + Feature in PascalCase
  • Java constant patterns and @Metadata annotations
  • Protocol header exemptions (e.g., Swift X-Container-Meta-, HTTP Content-Type)
  • Security interaction with HeaderFilterStrategy — why the Camel* prefix matters
  • Upgrade guide requirements for header renames
  • Backward compatibility policy (hard break, no aliases, as of 4.21)
  • Backport policy for maintenance branches

Test plan

  • Verify design/headers.adoc exists with correct frontmatter
  • Verify AGENTS.md references the new document
  • No build impact (non-compiled files only)

Claude Code on behalf of Guillaume Nodet

gnodet and others added 2 commits May 22, 2026 13:22
The existing documents (security, tracing, mdc) are all implemented
design decisions, not proposals. Rename the directory to better
reflect its contents.

Update all references in AGENTS.md (symlinked as CLAUDE.md) and
security-model.adoc.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add design/headers.adoc documenting the Exchange header naming
convention: "Camel" + ComponentName + Feature in PascalCase.

Covers the naming rules, constants class pattern, @metadata
annotations, protocol header exemptions, security interaction
with HeaderFilterStrategy, upgrade guide requirements, and
backward compatibility policy.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@gnodet gnodet requested review from apupier, davsclaus and oscerd May 22, 2026 11:24
@github-actions github-actions Bot added the docs label May 22, 2026
@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

github-actions Bot commented May 22, 2026

ℹ️ CI did not run targeted module tests.


⚙️ View full build and test results

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@gnodet gnodet merged commit 0bdacc9 into apache:main May 22, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants