Skip to content

CAMEL-23576: docs - sync camel-jira upgrade-guide entry to main (4_18 / 4_14) and flag as potential breaking change #23475

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
oscerd merged 1 commit into from
May 22, 2026
+121 −1
Merged

CAMEL-23576: docs - sync camel-jira upgrade-guide entry to main (4_18 / 4_14) and flag as potential breaking change #23475

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 60 additions & 0 deletions docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_14.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,66 @@ Even with the opt-in, route authors should still strip the namespace with
In addition, the inbound `MailHeaderFilterStrategy` now blocks the `mail.smtp.` / `mail.smtps.`
prefix as well, so an external mail message can no longer inject these into a downstream exchange.

=== camel-jira - potential breaking change

The Exchange header constants in `JiraConstants` have been renamed to follow the
Camel naming convention used across the rest of the component catalog. The Java
field names are unchanged; only the header string values have changed:

[options="header"]
|===
| Constant | Previous value | New value
| `JiraConstants.ISSUE_ASSIGNEE_ID` | `IssueAssigneeId` | `CamelJiraIssueAssigneeId`
| `JiraConstants.ISSUE_ASSIGNEE` | `IssueAssignee` | `CamelJiraIssueAssignee`
| `JiraConstants.ISSUE_COMPONENTS` | `IssueComponents` | `CamelJiraIssueComponents`
| `JiraConstants.ISSUE_COMMENT` | `IssueComment` | `CamelJiraIssueComment`
| `JiraConstants.ISSUE_CHANGED` | `IssueChanged` | `CamelJiraIssueChanged`
| `JiraConstants.ISSUE_KEY` | `IssueKey` | `CamelJiraIssueKey`
| `JiraConstants.ISSUE_PRIORITY_ID` | `IssuePriorityId` | `CamelJiraIssuePriorityId`
| `JiraConstants.ISSUE_PRIORITY_NAME` | `IssuePriorityName` | `CamelJiraIssuePriorityName`
| `JiraConstants.ISSUE_PROJECT_KEY` | `ProjectKey` | `CamelJiraIssueProjectKey`
| `JiraConstants.ISSUE_SUMMARY` | `IssueSummary` | `CamelJiraIssueSummary`
| `JiraConstants.ISSUE_TRANSITION_ID` | `IssueTransitionId` | `CamelJiraIssueTransitionId`
| `JiraConstants.ISSUE_TYPE_ID` | `IssueTypeId` | `CamelJiraIssueTypeId`
| `JiraConstants.ISSUE_TYPE_NAME` | `IssueTypeName` | `CamelJiraIssueTypeName`
| `JiraConstants.ISSUE_WATCHED_ISSUES` | `IssueWatchedIssues` | `CamelJiraIssueWatchedIssues`
| `JiraConstants.ISSUE_WATCHERS_ADD` | `IssueWatchersAdd` | `CamelJiraIssueWatchersAdd`
| `JiraConstants.ISSUE_WATCHERS_REMOVE` | `IssueWatchersRemove` | `CamelJiraIssueWatchersRemove`
| `JiraConstants.PARENT_ISSUE_KEY` | `ParentIssueKey` | `CamelJiraParentIssueKey`
| `JiraConstants.CHILD_ISSUE_KEY` | `ChildIssueKey` | `CamelJiraChildIssueKey`
| `JiraConstants.LINK_TYPE` | `linkType` | `CamelJiraLinkType`
| `JiraConstants.MINUTES_SPENT` | `minutesSpent` | `CamelJiraMinutesSpent`
|===

Routes that reference the constants symbolically (for example
`setHeader(JiraConstants.ISSUE_KEY, ...)`) continue to work without changes.
Routes that set the header by its literal string value (for example
`setHeader("IssueKey", ...)`) must be updated to use the new value
(`setHeader("CamelJiraIssueKey", ...)`).

As a consequence, the generated Endpoint DSL header accessors on
`JiraHeaderNameBuilder` have been renamed accordingly:

* `issueAssigneeId()` -> `jiraIssueAssigneeId()`
* `issueAssignee()` -> `jiraIssueAssignee()`
* `issueComponents()` -> `jiraIssueComponents()`
* `issueChanged()` -> `jiraIssueChanged()`
* `issueKey()` -> `jiraIssueKey()`
* `issuePriorityId()` -> `jiraIssuePriorityId()`
* `issuePriorityName()` -> `jiraIssuePriorityName()`
* `projectKey()` -> `jiraIssueProjectKey()`
* `issueSummary()` -> `jiraIssueSummary()`
* `issueTransitionId()` -> `jiraIssueTransitionId()`
* `issueTypeId()` -> `jiraIssueTypeId()`
* `issueTypeName()` -> `jiraIssueTypeName()`
* `issueWatchedIssues()` -> `jiraIssueWatchedIssues()`
* `issueWatchersAdd()` -> `jiraIssueWatchersAdd()`
* `issueWatchersRemove()` -> `jiraIssueWatchersRemove()`
* `parentIssueKey()` -> `jiraParentIssueKey()`
* `childIssueKey()` -> `jiraChildIssueKey()`
* `linkType()` -> `jiraLinkType()`
* `minutesSpent()` -> `jiraMinutesSpent()`

== Upgrading from 4.14.2 to 4.14.3

=== camel-tika
Expand Down
60 changes: 60 additions & 0 deletions docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_18.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,66 @@ Even with the opt-in, route authors should still strip the namespace with
In addition, the inbound `MailHeaderFilterStrategy` now blocks the `mail.smtp.` / `mail.smtps.`
prefix as well, so an external mail message can no longer inject these into a downstream exchange.

=== camel-jira - potential breaking change

The Exchange header constants in `JiraConstants` have been renamed to follow the
Camel naming convention used across the rest of the component catalog. The Java
field names are unchanged; only the header string values have changed:

[options="header"]
|===
| Constant | Previous value | New value
| `JiraConstants.ISSUE_ASSIGNEE_ID` | `IssueAssigneeId` | `CamelJiraIssueAssigneeId`
| `JiraConstants.ISSUE_ASSIGNEE` | `IssueAssignee` | `CamelJiraIssueAssignee`
| `JiraConstants.ISSUE_COMPONENTS` | `IssueComponents` | `CamelJiraIssueComponents`
| `JiraConstants.ISSUE_COMMENT` | `IssueComment` | `CamelJiraIssueComment`
| `JiraConstants.ISSUE_CHANGED` | `IssueChanged` | `CamelJiraIssueChanged`
| `JiraConstants.ISSUE_KEY` | `IssueKey` | `CamelJiraIssueKey`
| `JiraConstants.ISSUE_PRIORITY_ID` | `IssuePriorityId` | `CamelJiraIssuePriorityId`
| `JiraConstants.ISSUE_PRIORITY_NAME` | `IssuePriorityName` | `CamelJiraIssuePriorityName`
| `JiraConstants.ISSUE_PROJECT_KEY` | `ProjectKey` | `CamelJiraIssueProjectKey`
| `JiraConstants.ISSUE_SUMMARY` | `IssueSummary` | `CamelJiraIssueSummary`
| `JiraConstants.ISSUE_TRANSITION_ID` | `IssueTransitionId` | `CamelJiraIssueTransitionId`
| `JiraConstants.ISSUE_TYPE_ID` | `IssueTypeId` | `CamelJiraIssueTypeId`
| `JiraConstants.ISSUE_TYPE_NAME` | `IssueTypeName` | `CamelJiraIssueTypeName`
| `JiraConstants.ISSUE_WATCHED_ISSUES` | `IssueWatchedIssues` | `CamelJiraIssueWatchedIssues`
| `JiraConstants.ISSUE_WATCHERS_ADD` | `IssueWatchersAdd` | `CamelJiraIssueWatchersAdd`
| `JiraConstants.ISSUE_WATCHERS_REMOVE` | `IssueWatchersRemove` | `CamelJiraIssueWatchersRemove`
| `JiraConstants.PARENT_ISSUE_KEY` | `ParentIssueKey` | `CamelJiraParentIssueKey`
| `JiraConstants.CHILD_ISSUE_KEY` | `ChildIssueKey` | `CamelJiraChildIssueKey`
| `JiraConstants.LINK_TYPE` | `linkType` | `CamelJiraLinkType`
| `JiraConstants.MINUTES_SPENT` | `minutesSpent` | `CamelJiraMinutesSpent`
|===

Routes that reference the constants symbolically (for example
`setHeader(JiraConstants.ISSUE_KEY, ...)`) continue to work without changes.
Routes that set the header by its literal string value (for example
`setHeader("IssueKey", ...)`) must be updated to use the new value
(`setHeader("CamelJiraIssueKey", ...)`).

As a consequence, the generated Endpoint DSL header accessors on
`JiraHeaderNameBuilder` have been renamed accordingly:

* `issueAssigneeId()` -> `jiraIssueAssigneeId()`
* `issueAssignee()` -> `jiraIssueAssignee()`
* `issueComponents()` -> `jiraIssueComponents()`
* `issueChanged()` -> `jiraIssueChanged()`
* `issueKey()` -> `jiraIssueKey()`
* `issuePriorityId()` -> `jiraIssuePriorityId()`
* `issuePriorityName()` -> `jiraIssuePriorityName()`
* `projectKey()` -> `jiraIssueProjectKey()`
* `issueSummary()` -> `jiraIssueSummary()`
* `issueTransitionId()` -> `jiraIssueTransitionId()`
* `issueTypeId()` -> `jiraIssueTypeId()`
* `issueTypeName()` -> `jiraIssueTypeName()`
* `issueWatchedIssues()` -> `jiraIssueWatchedIssues()`
* `issueWatchersAdd()` -> `jiraIssueWatchersAdd()`
* `issueWatchersRemove()` -> `jiraIssueWatchersRemove()`
* `parentIssueKey()` -> `jiraParentIssueKey()`
* `childIssueKey()` -> `jiraChildIssueKey()`
* `linkType()` -> `jiraLinkType()`
* `minutesSpent()` -> `jiraMinutesSpent()`

== Upgrading from 4.18.0 to 4.18.1

=== camel-bom
Expand Down
2 changes: 1 addition & 1 deletion docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_21.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -689,7 +689,7 @@ to work without changes. Routes that set the header by its literal string value
(for example `setHeader("JGROUPSRAFT_SET_TIMEOUT", ...)`) must be updated to
use the new value (`setHeader("CamelJGroupsRaftSetTimeout", ...)`).

=== camel-jira
=== camel-jira - potential breaking change

The Exchange header constants in `JiraConstants` have been renamed to follow the
Camel naming convention used across the rest of the component catalog. The Java
Expand Down