Skip to content
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

JIRA: Add notify_users option to 2 methods #1278

Merged
merged 3 commits into from
Dec 8, 2023
Merged

JIRA: Add notify_users option to 2 methods #1278

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d493e21
Add notify_users option to 2 methods
jerubball Dec 7, 2023
91d8726
Update JIRA docs
jerubball Dec 7, 2023
98b3a6a
Add docstring for `update_issue_field`
jerubball Dec 7, 2023
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
19 changes: 16 additions & 3 deletions atlassian/jira.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1160,11 +1160,22 @@ def issue_fields(self, key):
issue = self.get("{base_url}/{key}".format(base_url=base_url, key=key))
return issue["fields"]

def update_issue_field(self, key, fields="*all"):
def update_issue_field(self, key, fields="*all", notify_users=True):
"""
Update an issue's fields.
:param key: str Issue id or issye key
:param fields: dict with target fields as keys and new contents as values
:param notify_users: bool OPTIONAL if True, use project's default notification scheme to notify users via email.
if False, do not send any email notifications. (only works with admin privilege)

Reference: https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issues/#api-rest-api-2-issue-issueidorkey-put
"""
base_url = self.resource_url("issue")
params = {"notifyUsers": "true" if notify_users else "false"}
return self.put(
"{base_url}/{key}".format(base_url=base_url, key=key),
data={"fields": fields},
params=params,
)

def bulk_update_issue_field(self, key_list, fields="*all"):
Expand Down Expand Up @@ -1465,13 +1476,14 @@ def issue_add_comment(self, issue_key, comment, visibility=None):
data["visibility"] = visibility
return self.post(url, data=data)

def issue_edit_comment(self, issue_key, comment_id, comment, visibility=None):
def issue_edit_comment(self, issue_key, comment_id, comment, visibility=None, notify_users=True):
"""
Updates an existing comment
:param issue_key: str
:param comment_id: int
:param comment: str
:param visibility: OPTIONAL
:param notify_users: bool OPTIONAL
:return:
"""
base_url = self.resource_url("issue")
Expand All @@ -1481,7 +1493,8 @@ def issue_edit_comment(self, issue_key, comment_id, comment, visibility=None):
data = {"body": comment}
if visibility:
data["visibility"] = visibility
return self.put(url, data=data)
params = {"notifyUsers": "true" if notify_users else "false"}
return self.put(url, data=data, params=params)

def get_issue_remotelinks(self, issue_key, global_id=None, internal_id=None):
"""
Expand Down
5 changes: 4 additions & 1 deletion docs/jira.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ Manage issues

# Update issue field
fields = {'summary': 'New summary'}
jira.update_issue_field(key, fields)
jira.update_issue_field(key, fields, notify_users=True)

# Get existing custom fields or find by filter
jira.get_custom_fields(self, search=None, start=1, limit=50):
Expand Down Expand Up @@ -316,6 +316,9 @@ Manage issues
# Add Comments
jira.issue_add_comment(issue_id_or_key, "This is a sample comment string.")

# Edit Comments
jira.issue_edit_comment(issue_key, comment_id, comment, visibility=None, notify_users=True)

# Issue Comments
jira.issue_get_comments(issue_id_or_key)

Expand Down
Loading