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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
