Skip to content

Commit

Permalink
Added get_dashboard method (#1109)
Browse files Browse the repository at this point in the history
* Added request_current_index_from_node method and docs for the cluster methods

* Added description to docs for method get_cluster_all_nodes

* Added get_dashboard method. Ability to get dashboard by ID.

* Fix resource_url for get_dashboard method
  • Loading branch information
SLRover authored Jan 12, 2023
1 parent 25170b7 commit 24a5b4f
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
10 changes: 10 additions & 0 deletions atlassian/jira.py
Original file line number Diff line number Diff line change
Expand Up @@ -649,6 +649,16 @@ def get_dashboards(self, filter="", start=0, limit=10):
url = self.resource_url("dashboard")
return self.get(url, params=params)

def get_dashboard(self, dashboard_id):
"""
Returns a single dashboard
:param dashboard_id: Dashboard ID Int
:return:
"""
url = self.resource_url("dashboard/{dashboard_id}".format(dashboard_id=dashboard_id))
return self.get(url)

"""
Filters. Resource for searches
Reference: https://docs.atlassian.com/software/jira/docs/api/REST/8.5.0/#api/2/filter
Expand Down
9 changes: 9 additions & 0 deletions docs/jira.rst
Original file line number Diff line number Diff line change
Expand Up @@ -293,6 +293,15 @@ Manage Boards
# Add/Move Issues to sprint
jira.add_issues_to_sprint(sprint_id, issues_list)
Manage dashboards
-----------------

.. code-block:: python
# Get dashboard by ID
jira.get_dashboard(dashboard_id)
Attachments actions
-------------------

Expand Down

0 comments on commit 24a5b4f

Please sign in to comment.