CAMEL-23576: camel-jira - align Exchange header constant names with Camel naming convention#23417
Conversation
…amel naming convention Renames the Exchange header string values in JiraConstants from non-Camel prefixed values (IssueKey, ProjectKey, IssueTransitionId, linkType, minutesSpent, ...) to CamelJira<Name>, following the convention used across the rest of the Camel component catalog and matching the pattern established in CAMEL-23526 (camel-cxf), CAMEL-23522 (camel-mail), CAMEL-23461 (camel-aws-bedrock), and CAMEL-23532 (camel-vertx-websocket / camel-atmosphere-websocket / camel-iggy). The Java field names (ISSUE_KEY, ISSUE_PROJECT_KEY, LINK_TYPE, ...) are unchanged so routes referencing the constants symbolically continue to work; routes using the literal string values must be updated (documented in the 4.21 upgrade guide). The generated Endpoint DSL header accessors on JiraHeaderNameBuilder have been renamed accordingly (issueKey() -> jiraIssueKey(), projectKey() -> jiraIssueProjectKey(), linkType() -> jiraLinkType(), ...). Updates the producer error messages that quote the header name for consistency. Tracker: CAMEL-23577 Reported by Claude Code on behalf of Andrea Cosentino Signed-off-by: Andrea Cosentino <ancosen@gmail.com>
|
🌟 Thank you for your contribution to the Apache Camel project! 🌟 🐫 Apache Camel Committers, please review the following items:
|
|
🧪 CI tested the following changed modules:
All tested modules (10 modules)
|
gnodet
left a comment
There was a problem hiding this comment.
LGTM — clean, well-documented header rename following the established CAMEL-23577 sweep pattern.
What's good:
- All 20
@Metadata-annotated headers +ISSUE_COMMENTrenamed consistently toCamelJira<Name> - Non-header constants (
JIRA_REST_CLIENT_FACTORY,ACCESS_TOKEN, etc.) correctly left unchanged - Producer error messages updated to match new header names
- Comprehensive upgrade guide entry with full old→new mapping table
- All generated files (catalog JSON, endpoint DSL) regenerated
- Tests pass without changes (they use symbolic constants)
One minor pre-existing doc issue flagged inline — not blocking.
Claude Code on behalf of Guillaume Nodet
Co-authored-by: Guillaume Nodet <gnodet@gmail.com>
…ue too Mirror the fix from 4b6d87a (AddIssue section) on the UpdateIssue section. `IssueDescription` is not a header constant; the description is read from the exchange body in `UpdateIssueProducer` as well, so the misleading bullet is replaced with a body-as-description note. Addresses the second of the two review comments from @gnodet on PR apache#23417. Reported by Claude Code on behalf of Andrea Cosentino Signed-off-by: Andrea Cosentino <ancosen@gmail.com>
gnodet
left a comment
There was a problem hiding this comment.
Looks good — all 19 header values correctly renamed to CamelJira* PascalCase convention. Good call excluding the non-header constants (OAuth keys, JiraRestClientFactory registry binding). Upgrade guide is thorough with full old-to-new mapping.
Claude Code on behalf of Guillaume Nodet
…amel naming convention (#23460) Backport of #23417 onto camel-4.18.x (target 4.18.3). Renames JiraConstants header values to CamelJira* (Java field names unchanged); documented in the 4.18 upgrade guide as a potential breaking change. Part of CAMEL-23577.
…amel naming convention (#23472) Backport of #23417 onto camel-4.14.x (target 4.14.8). Renames JiraConstants header values to CamelJira* (Java field names unchanged); documented in the 4.14 upgrade guide as a potential breaking change. Part of CAMEL-23577.
Summary
JiraConstantsfrom non-Camel-prefixed values (IssueKey,ProjectKey,IssueTransitionId,linkType,minutesSpent, …) toCamelJira<Name>, following the convention used across the rest of the Camel component catalog.ISSUE_KEY,ISSUE_PROJECT_KEY,LINK_TYPE, …) are unchanged so routes referencing the constants symbolically continue to work without modification.JiraHeaderNameBuilderare renamed accordingly (issueKey()→jiraIssueKey(),projectKey()→jiraIssueProjectKey(),linkType()→jiraLinkType(), …).camel-4x-upgrade-guide-4_21.adoc.This follows the rename pattern established in CAMEL-23526 (
camel-cxf), CAMEL-23461 (camel-aws-bedrock), CAMEL-23522 (camel-mail), CAMEL-23532 (camel-vertx-websocket/camel-atmosphere-websocket/camel-iggy), CAMEL-23515 (camel-nats), and CAMEL-23516 (camel-xmpp).Tracking ticket: CAMEL-23577 (global sweep) — this is one of the cluster sub-tasks.
Backports
The defect predates 4.x;
JiraConstantshas the same layout oncamel-4.18.xandcamel-4.14.x. Targeted fix versions: 4.21.0, 4.18.3, 4.14.8.Test plan
mvn -DskipTests installincomponents/camel-jira— catalog and component docs regenerated cleanly.mvn clean install -DskipTestsfrom repo root — endpoint DSLJiraEndpointBuilderFactoryregenerated with new method names; no other regen drift.JiraConstants.java(verified by grep acrosssrc/main,src/test,*.adoc,*.xml,*.json).ISSUE_KEY,ISSUE_TRANSITION_ID, …) via static import — no test changes required.Reported by Claude Code on behalf of Andrea Cosentino