Skip to content

Commit eb7ad58

Browse files
feat: add xray rest api (server/data-center) support (atlassian-api#559)
* feat: add xray rest api (server/data-center) support This commits adds support for v1.0 of the Xray REST api for Server and Data-Center. As of now, v2.0 does not cover all functionality provided in the initial version, mainly related to test automation (eg. import of test executions/...). * docs: update documentation for the xray module * fix: expose module correctly
1 parent eb86bf1 commit eb7ad58

File tree

7 files changed

+583
-4
lines changed

7 files changed

+583
-4
lines changed

CONTRIBUTING.rst

+2
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,8 @@ All methods based on docs from: https://developer.atlassian.com/docs/
7777
- https://developer.atlassian.com/platform/marketplace/rest
7878
* Crowd:
7979
- https://developer.atlassian.com/server/crowd/crowd-rest-apis/
80+
* Xray:
81+
- https://docs.getxray.app/display/XRAY/REST+API
8082
* Others:
8183
- https://developer.atlassian.com/server/jira/platform/oauth/
8284
- https://confluence.atlassian.com/cloud/api-tokens-938839638.html

README.rst

+14
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,20 @@ Example to get your requests:
8181
data = sd.get_my_customer_requests()
8282
print(data)
8383
84+
Using Xray (Test Management tool for Jira):
85+
86+
.. code-block:: python
87+
88+
from atlassian import Xray
89+
90+
xr = Xray(
91+
url='http://localhost:7990',
92+
username='admin',
93+
password='admin')
94+
95+
data = xr.get_tests('TEST-001')
96+
print(data)
97+
8498
If you want to see the response in pretty print format JSON. Feel free for use construction like:
8599

86100
.. code-block:: python

atlassian/__init__.py

+3-1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
from .marketplace import MarketPlace
88
from .portfolio import Portfolio
99
from .service_desk import ServiceDesk
10+
from .xray import Xray
1011

1112
__all__ = [
1213
'Confluence',
@@ -17,5 +18,6 @@
1718
'Stash',
1819
'Crowd',
1920
'ServiceDesk',
20-
'MarketPlace'
21+
'MarketPlace',
22+
'Xray'
2123
]

0 commit comments

Comments
 (0)