You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by "oscerd (via GitHub)" <gi...@apache.org> on 2026/05/21 10:29:59 UTC
[PR] CAMEL-23576: camel-jira - align Exchange header constant names with Camel naming convention [camel]
oscerd opened a new pull request, #23417:
URL: https://github.com/apache/camel/pull/23417
## Summary
- 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.
- The Java field names (`ISSUE_KEY`, `ISSUE_PROJECT_KEY`, `LINK_TYPE`, …) are unchanged so routes referencing the constants symbolically continue to work without modification.
- The generated Endpoint DSL header accessors on `JiraHeaderNameBuilder` are renamed accordingly (`issueKey()` → `jiraIssueKey()`, `projectKey()` → `jiraIssueProjectKey()`, `linkType()` → `jiraLinkType()`, …).
- Producer error messages that quote the old header names are updated for consistency.
- Upgrade-guide entry added in `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; `JiraConstants` has the same layout on `camel-4.18.x` and `camel-4.14.x`. Targeted fix versions: **4.21.0, 4.18.3, 4.14.8**.
## Test plan
- [x] `mvn -DskipTests install` in `components/camel-jira` — catalog and component docs regenerated cleanly.
- [x] Full reactor build `mvn clean install -DskipTests` from repo root — endpoint DSL `JiraEndpointBuilderFactory` regenerated with new method names; no other regen drift.
- [x] No literal-string usages of the old header values exist anywhere in the repo outside `JiraConstants.java` (verified by grep across `src/main`, `src/test`, `*.adoc`, `*.xml`, `*.json`).
- [x] All test code already references the Java fields (`ISSUE_KEY`, `ISSUE_TRANSITION_ID`, …) via static import — no test changes required.
- [ ] CI verifies the full build (no local-only failures).
_Reported by Claude Code on behalf of Andrea Cosentino_
--
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-23576: camel-jira - align Exchange header constant names with Camel naming convention [camel]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #23417:
URL: https://github.com/apache/camel/pull/23417#issuecomment-4507235759
: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-23576: camel-jira - align Exchange header constant names with Camel naming convention [camel]
Posted by "gnodet (via GitHub)" <gi...@apache.org>.
gnodet commented on code in PR #23417:
URL: https://github.com/apache/camel/pull/23417#discussion_r3280804481
##########
components/camel-jira/src/main/docs/jira-component.adoc:
##########
@@ -193,39 +193,39 @@ Only one file should attach per invocation.
Required:
-* `IssueKey`: The issue key identifier.
+* `CamelJiraIssueKey`: The issue key identifier.
* body of the exchange should be of type `File`
=== DeleteIssue
Required:
-* `IssueKey`: The issue key identifier.
+* `CamelJiraIssueKey`: The issue key identifier.
=== TransitionIssue
Required:
-* `IssueKey`: The issue key identifier.
-* `IssueTransitionId`: The issue transition `id`.
+* `CamelJiraIssueKey`: The issue key identifier.
+* `CamelJiraIssueTransitionId`: The issue transition `id`.
* the body of the exchange is the description.
=== UpdateIssue
-* `IssueKey`: The issue key identifier.
-* `IssueTypeId` or `IssueTypeName`: The `id` of the issue type or the name of the issue type, you can see the valid list in `\http://jira_server/rest/api/2/issue/createmeta?projectKeys=SAMPLE_KEY`.
-* `IssueSummary`: The summary of the issue.
-* `IssueAssignee`: the assignee user
-* `IssueAssigneeId`: the assignee user id
-* `IssuePriorityId` or `IssuePriorityName`: The priority of the issue, you can see the valid list in `\http://jira_server/rest/api/2/priority`.
-* `IssueComponents`: A list of string with the valid component names.
+* `CamelJiraIssueKey`: The issue key identifier.
+* `CamelJiraIssueTypeId` or `CamelJiraIssueTypeName`: The `id` of the issue type or the name of the issue type, you can see the valid list in `\http://jira_server/rest/api/2/issue/createmeta?projectKeys=SAMPLE_KEY`.
+* `CamelJiraIssueSummary`: The summary of the issue.
+* `CamelJiraIssueAssignee`: the assignee user
+* `CamelJiraIssueAssigneeId`: the assignee user id
+* `CamelJiraIssuePriorityId` or `CamelJiraIssuePriorityName`: The priority of the issue, you can see the valid list in `\http://jira_server/rest/api/2/priority`.
+* `CamelJiraIssueComponents`: A list of string with the valid component names.
* `IssueDescription`: The description of the issue.
Review Comment:
Same as above — `IssueDescription` is not a header constant, the description comes from the exchange body.
```suggestion
* The exchange body is used as the issue description.
```
##########
components/camel-jira/src/main/docs/jira-component.adoc:
##########
@@ -167,24 +167,24 @@ There are operations that requires `id` for fields such as the issue type, prior
Required:
-* `ProjectKey`: The project key, example: CAMEL, HHH, MYP.
-* `IssueTypeId` or `IssueTypeName`: The `id` of the issue type or the name of the issue type, you can see the valid list in `\http://jira_server/rest/api/2/issue/createmeta?projectKeys=SAMPLE_KEY`.
-* `IssueSummary`: The summary of the issue.
+* `CamelJiraIssueProjectKey`: The project key, example: CAMEL, HHH, MYP.
+* `CamelJiraIssueTypeId` or `CamelJiraIssueTypeName`: The `id` of the issue type or the name of the issue type, you can see the valid list in `\http://jira_server/rest/api/2/issue/createmeta?projectKeys=SAMPLE_KEY`.
+* `CamelJiraIssueSummary`: The summary of the issue.
Optional:
-* `IssueAssignee`: the assignee user
-* `IssueAssigneeId`: the assignee user id
-* `IssuePriorityId` or `IssuePriorityName`: The priority of the issue, you can see the valid list in `\http://jira_server/rest/api/2/priority`.
-* `IssueComponents`: A list of string with the valid component names.
-* `IssueWatchersAdd`: A list of strings with the usernames (or id) to add to the watcher list.
+* `CamelJiraIssueAssignee`: the assignee user
+* `CamelJiraIssueAssigneeId`: the assignee user id
+* `CamelJiraIssuePriorityId` or `CamelJiraIssuePriorityName`: The priority of the issue, you can see the valid list in `\http://jira_server/rest/api/2/priority`.
+* `CamelJiraIssueComponents`: A list of string with the valid component names.
+* `CamelJiraIssueWatchersAdd`: A list of strings with the usernames (or id) to add to the watcher list.
* `IssueDescription`: The description of the issue.
Review Comment:
Pre-existing issue (not introduced by this PR): `IssueDescription` is listed here alongside actual Exchange headers, but it does not exist as a constant in `JiraConstants.java`. The description is actually set via the exchange body (`exchange.getIn().getBody(String.class)` in `AddIssueProducer` and `UpdateIssueProducer`), not a header.
Since this PR is cleaning up header references in the doc, it would be a nice follow-up to clarify this. For example:
```suggestion
* The exchange body is used as the issue description.
```
Non-blocking — this predates the PR.
--
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-23576: camel-jira - align Exchange header constant names with Camel naming convention [camel]
Posted by "oscerd (via GitHub)" <gi...@apache.org>.
oscerd merged PR #23417:
URL: https://github.com/apache/camel/pull/23417
--
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-23576: camel-jira - align Exchange header constant names with Camel naming convention [camel]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #23417:
URL: https://github.com/apache/camel/pull/23417#issuecomment-4507367561
<!-- ci-tested-modules -->
:test_tube: **CI tested the following changed modules:**
- `catalog/camel-catalog`
- `components/camel-jira`
- `docs`
- `dsl/camel-endpointdsl`
<details><summary>All tested modules (10 modules)</summary>
- Camel :: Catalog :: Camel Catalog
- Camel :: Endpoint DSL
- Camel :: JBang :: MCP
- Camel :: JBang :: Plugin :: Route Parser
- Camel :: JBang :: Plugin :: TUI
- Camel :: JBang :: Plugin :: Validate
- Camel :: JIRA
- Camel :: Launcher :: Container
- Camel :: YAML DSL :: Validator
- Camel :: YAML DSL :: Validator Maven Plugin
</details>
---
:gear: [View full build and test results](https://github.com/apache/camel/actions/runs/26220520515)
--
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