search

nassauwinter / zephyr-python-api

Python wrappers for Zephyr Scale API
Apache License 2.0
1 stars 4 forks source link

Zephyr Scale Server REST API for iterations #18

Open crapitea opened 6 months ago

crapitea commented 6 months ago

From what I've observed, the current Zephyr Scale Server API doesn't have an Endpoint for Iterations: https://support.smartbear.com/zephyr-scale-server/api-docs/v1/

Looking at their interface, it seems like they are using a different API endpoint for generating / listing iterations: https://jira.project.com/rest/tests/1.0/ vs https://jira.project.com/rest/atm/1.0/

So, for example, to get the iterations for a specific project, using the undocumented API, you can just do: https://jira.project.com/rest/tests/1.0/iteration?projectId=11101

Without enabling the support for these APIs, the things you can do in Zephyr Scale with this module will remain limited. That being said, shouldn't the architecture be modified a bit so that both endpoints are supported?

nassauwinter commented 5 months ago

Hi @crapitea! Thank you for the suggestion.

Is this a part of some Jira API? I'm not that familiar with the iterations.

crapitea commented 5 months ago

I don't think that they're part of the Jira API. I might be wrong about this, but I haven't seen any mention about them in Jira yet.

In Zephyr Scale, the iterations are part of the 'Configuration' panel, like how are the environments. From what I could tell, for Zephyr Squad Server there is an API for the environments configuration, but there isn't anything similar for iterations. If you use their GUI to create an iteration, you get the endpoints I mentioned above.

The thing is that when you create an execution, you can specify what environment you used and what is the iteration. However, even if you can use the iteration by name, you cannot query/create/remove them other than using the GUI.