jira issue comment edit¶
- Usage:
jira issue comment edit KEY COMMENT_ID [flags]
Replace a comment body and optionally adjust its visibility. Use comment list first when you need to find the comment ID.
The replacement body runs through the validate-and-encode ADF pipeline before submission. --dry-run previews the validated body and visibility change without contacting Jira.
Input¶
--json-input <FILE>¶
New body as native ADF JSON file (canonical for agents)
Accepts a file.
--markdown <MARKDOWN>¶
New body as Markdown
--markdown-file <FILE>¶
Read the Markdown body from a file; - reads stdin
Accepts a file.
Visibility¶
--clear-visibility¶
Remove any existing visibility restriction
--visibility-group <GROUP>¶
Replace visibility with a Jira group
--visibility-role <ROLE>¶
Replace visibility with a Jira role
Safety¶
--dry-run¶
Preview without calling Jira
Output fields¶
With --output json, the response envelope's data object carries these fields. Run jira agent schema for the full machine-readable schema.
| Field | Type | Description |
|---|---|---|
body_adf_summary |
object | The validated ADF document proposed or submitted by the command. |
comment.author |
object | null | Fields: account_id, display_name, email_address |
comment.body |
||
comment.created |
string | |
comment.id |
string | |
comment.update_author |
object | null | Fields: account_id, display_name, email_address |
comment.updated |
string | |
comment.visibility |
object | null | Fields: type, value |
comment_id |
string | |
dry_run |
boolean | |
issue.id |
string | |
issue.key |
string | |
issue.self |
string | |
visibility_change |
string |
Examples¶
jira issue comment edit PROJ-123 10042 --markdown "Updated: rollout complete." # (1)!
jira issue comment edit PROJ-123 10042 --markdown "Now public." --clear-visibility # (2)!
jira issue comment edit PROJ-123 10042 --markdown "Draft update." --dry-run # (3)!
- Replace a comment body with new Markdown
- Remove a comment's visibility restriction
- Preview a comment edit