Skip to content

[Doc] [Jira] Update info about jira.get_issue_tree_recursive method #1544

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[Doc] [Jira] Update info about jira.get_issue_tree_recursive method #1544

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions docs/jira.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -395,8 +395,13 @@ Manage issues
# Scrap regex matches from issue description and comments:
jira.scrap_regex_from_issue(issue_key, regex)

# Get tree representation of issue and its subtasks + inward issue links
jira.get_issue_tree(issue_key)
# Get a list that contains the tree structure of the root issue, with all subtasks and inward linked issues.
# (!) Function only returns child issues from the same Jira instance or from an instance to which the API key has access.
# :param issue_key: Jira issue key
# :param tree: list to store the tree structure for recursion. Do not change it.
# :param depth: current depth of the tree for recursion. Do not change it.
# :return: list of dictionaries containing the tree structure. Dictionary element contains a key (parent issue) and value (child issue).
jira.get_issue_tree_recursive(issue_key, tree=[], depth=0)

Epic Issues
-------------
Expand Down