Skip to content

Commit 4e86988

Browse files
authored
Jira: Add ability to add icons to issue remote links (atlassian-api#1040)
1 parent 66defa1 commit 4e86988

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

atlassian/jira.py

+12-1
Original file line numberDiff line numberDiff line change
@@ -1321,14 +1321,18 @@ def get_issue_remote_links(self, issue_key, global_id=None, internal_id=None):
13211321
url += "/" + internal_id
13221322
return self.get(url, params=params)
13231323

1324-
def create_or_update_issue_remote_links(self, issue_key, link_url, title, global_id=None, relationship=None):
1324+
def create_or_update_issue_remote_links(
1325+
self, issue_key, link_url, title, global_id=None, relationship=None, icon_url=None, icon_title=None
1326+
):
13251327
"""
13261328
Add Remote Link to Issue, update url if global_id is passed
13271329
:param issue_key: str
13281330
:param link_url: str
13291331
:param title: str
13301332
:param global_id: str, OPTIONAL:
13311333
:param relationship: str, OPTIONAL: Default by built-in method: 'Web Link'
1334+
:param icon_url: str, OPTIONAL: Link to a 16x16 icon representing the type of the object in the remote system
1335+
:param icon_title: str, OPTIONAL: Text for the tooltip of the main icon describing the type of the object in the remote system
13321336
"""
13331337
base_url = self.resource_url("issue")
13341338
url = "{base_url}/{issue_key}/remotelink".format(base_url=base_url, issue_key=issue_key)
@@ -1337,6 +1341,13 @@ def create_or_update_issue_remote_links(self, issue_key, link_url, title, global
13371341
data["globalId"] = global_id
13381342
if relationship:
13391343
data["relationship"] = relationship
1344+
if icon_url or icon_title:
1345+
icon_data = {}
1346+
if icon_url:
1347+
icon_data["url16x16"] = icon_url
1348+
if icon_title:
1349+
icon_data["title"] = icon_title
1350+
data["icon"] = icon_data
13401351
return self.post(url, data=data)
13411352

13421353
def get_issue_remote_link_by_id(self, issue_key, link_id):

docs/jira.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ Manage issues
232232
jira.remove_issue_link(link_id)
233233
234234
# Create or Update Issue Remote Links
235-
jira.create_or_update_issue_remote_links(issue_key, link_url, title, global_id=None, relationship=None)
235+
jira.create_or_update_issue_remote_links(issue_key, link_url, title, global_id=None, relationship=None, icon_url=None, icon_title=None)
236236
237237
# Get Issue Remote Link by link ID
238238
jira.get_issue_remote_link_by_id(issue_key, link_id)

0 commit comments

Comments
 (0)