Skip to content

Commit f9a5d4c

Browse files
authored
[Jira] Implement jira.update_version (atlassian-api#878)
* [Jira] Implement jira.update_version * [Jira] Fix formatting on jira.update_version
1 parent 20878b8 commit f9a5d4c

File tree

2 files changed

+33
-0
lines changed

2 files changed

+33
-0
lines changed

atlassian/jira.py

+30
Original file line numberDiff line numberDiff line change
@@ -1786,6 +1786,36 @@ def delete_version(self, version, moved_fixed=None, move_affected=None):
17861786
payload = {"moveFixIssuesTo": moved_fixed, "moveAffectedIssuesTo": move_affected}
17871787
return self.delete("rest/api/2/version/{}".format(version), data=payload)
17881788

1789+
def update_version(
1790+
self,
1791+
version,
1792+
name=None,
1793+
description=None,
1794+
is_archived=None,
1795+
is_released=None,
1796+
start_date=None,
1797+
release_date=None,
1798+
):
1799+
"""
1800+
Update a project version
1801+
:param version: The version id to update
1802+
:param name: The version name
1803+
:param description: The version description
1804+
:param is_archived:
1805+
:param is_released:
1806+
:param startDate: The Start Date in isoformat. Example value is "2015-04-11T15:22:00.000+10:00"
1807+
:param releaseDate: The Release Date in isoformat. Example value is "2015-04-11T15:22:00.000+10:00"
1808+
"""
1809+
payload = {
1810+
"name": name,
1811+
"description": description,
1812+
"archived": is_archived,
1813+
"released": is_released,
1814+
"startDate": start_date,
1815+
"releaseDate": release_date,
1816+
}
1817+
return self.put("rest/api/3/version/{}".format(version), data=payload)
1818+
17891819
def get_project_roles(self, project_key):
17901820
"""
17911821
Provide associated project roles

docs/jira.rst

+3
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,9 @@ Manage projects
104104
# Add missing version to project
105105
jira.add_version(key, project_id, version, is_archived=False, is_released=False)
106106
107+
# Update an existing version
108+
jira.update_version(version, name=None, description=None, is_archived=None, is_released=None, start_date=None, release_date=None)
109+
107110
# Get project leaders
108111
jira.project_leaders()
109112

0 commit comments

Comments
 (0)