Xray REST API: why are there resources with and without 'api' in the URL?

[Dominik]

Hi,

I'm using the REST API of the Xray plugin and noticed that some resources are duplicated. For example, test steps can be obtained in two ways:

1. raven/1.0/api/test/{testKey}/step

2. raven/1.0/test/{testKey}/steps

The "/api/" methods are those being described in the recent Xray REST API documentation, but I've used the other ones so far. Are the URLs without "/api/" in the path being deprecated? Or are they both valid? If so, what's the difference?

Regards, Dominik

[André Miguel Pereira Rodrigues · Accepted solution]

Hi,

Yes my mistake that's what i meant, The not /api/ are the ones we use internally and are not documented.

You can see the documentation per version in the following link: http://confluence.xpand-addons.com/dosearchsite.action?queryString=Xray&type=spacedesc the documentation for version 1.12.x is the latest version one.

Best Regards,

André Rodrigues

[Dominik]

Thanks!

[Dominik]

Hi André,

Thanks for the quick reply. Actually, the "/api/" methods are those that are documented. At least when I visit the following page, they are listed and described with examples:

http://confluence.xpand-addons.com/display/XRAY/Test+Steps+-+REST

If I remember correctly, a month or two ago, the documentation looked different... is it possible to view the documentation for an exact version of Xray? Such as 1.12.1?

Greetings,

Dominik

[joseantonio.gornes]

Hi,

Is the api updated? I'm trying to get Preconditions or Test Set via api:

GET /rest/raven/1.0/api/precondition/{preConditionKey}/test

GET /rest/raven/1.0/api/testset/{testSetKey}/test

But for both I'm getting: 404</status-code><message>null for uri

I've tested my credentials with the api from Jira and it works fine with it. 

Regards.

[André Miguel Pereira Rodrigues]

Hi,

The "/api/" ones are the ones we use internally, these methods are not documented and don't always return the same data as the "/api/" ones, if possible you should always try to use the "/api/" ones but they are both valid.

Best Regards,

André Rodrigues