Skip to content

Commit

Permalink
Add docstring for update_issue_field
Browse files Browse the repository at this point in the history
  • Loading branch information
jerubball authored Dec 7, 2023
1 parent 91d8726 commit 98b3a6a
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions atlassian/jira.py
Original file line number Diff line number Diff line change
Expand Up @@ -1161,6 +1161,15 @@ def issue_fields(self, key):
return issue["fields"]

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(
Expand Down

0 comments on commit 98b3a6a

Please sign in to comment.