Skip to content

Commit 7665275

Browse files
Jira: add parameters to query string i.o. request data. (#585)
* Update jira.py Bugfix: pass parameters to query string i.o. request data. Add additional parameters. * Add 'query' and 'status' filters' to "get project versions paginated" More info can be found at: https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-project-versions/#api-rest-api-2-project-projectidorkey-version-get
1 parent 965c93a commit 7665275

File tree

2 files changed

+10
-3
lines changed

2 files changed

+10
-3
lines changed

atlassian/jira.py

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1438,7 +1438,7 @@ def get_project_versions(self, key, expand=None):
14381438
params['expand'] = expand
14391439
return self.get('rest/api/2/project/{}/versions'.format(key), params=params)
14401440

1441-
def get_project_versions_paginated(self, key, start=None, limit=None, order_by=None, expand=None):
1441+
def get_project_versions_paginated(self, key, start=None, limit=None, order_by=None, expand=None, query=None, status=None):
14421442
"""
14431443
Returns all versions for the specified project. Results are paginated.
14441444
Results can be ordered by the following fields:
@@ -1451,6 +1451,8 @@ def get_project_versions_paginated(self, key, start=None, limit=None, order_by=N
14511451
:param limit: how many results on the page should be included. Defaults to 50.
14521452
:param order_by: ordering of the results.
14531453
:param expand: the parameters to expand
1454+
:param query: Filter the results using a literal string. Versions with matching name or description are returned (case insensitive).
1455+
:param status: A list of status values used to filter the results by version status. This parameter accepts a comma-separated list. The status values are released, unreleased, and archived..
14541456
:return:
14551457
"""
14561458
params = {}
@@ -1462,7 +1464,11 @@ def get_project_versions_paginated(self, key, start=None, limit=None, order_by=N
14621464
params['orderBy'] = order_by
14631465
if expand is not None:
14641466
params['expand'] = expand
1465-
return self.get('rest/api/2/project/{}/version'.format(key), params)
1467+
if query is not None:
1468+
params['query'] = query
1469+
if status in ['released', 'unreleased', 'archived']:
1470+
params['status'] = status
1471+
return self.get('rest/api/2/project/{}/version'.format(key), params=params)
14661472

14671473
def add_version(self, project_key, project_id, version, is_archived=False, is_released=False):
14681474
"""

docs/jira.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,8 @@ Manage projects
9898
9999
# Returns all versions for the specified project. Results are paginated.
100100
# Results can be ordered by the following fields: sequence, name, startDate, releaseDate.
101-
jira.get_project_versions_paginated(key, start=None, limit=None, order_by=None, expand=None)
101+
# Results can be filtered by the following fields: query, status.
102+
jira.get_project_versions_paginated(key, start=None, limit=None, order_by=None, expand=None, query=None, status=None)
102103
103104
# Add missing version to project
104105
jira.add_version(key, project_id, version, is_archived=False, is_released=False)

0 commit comments

Comments
 (0)