From 98b3a6aa682fd8964ba994ab09583314f7b7e001 Mon Sep 17 00:00:00 2001 From: Hasol Im Date: Thu, 7 Dec 2023 11:50:21 -0500 Subject: [PATCH] Add docstring for `update_issue_field` --- atlassian/jira.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/atlassian/jira.py b/atlassian/jira.py index e00a3b73b..3e49d722e 100644 --- a/atlassian/jira.py +++ b/atlassian/jira.py @@ -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(