Requirement Yogi JSON format from API call

Question

Greetings,

We are looking to create a simple script that can query requirements using the requirement yogi API ( GET /rest/reqs/1/requirement2/{spaceKey} ) . Before starting on this, I was wondering how stable the format of the JSON would be. Would we only see changes on major version updates? Or could we also see format changes on minor versions as well?

Currently, we have a script that is able to parse a table of requirements out of HTML that we are looking to update for more general use.

Gonchik Tsymzhitov · Accepted Answer

Hi!

looks like that page is better for double check:

* https://developer.requirementyogi.com/javadocs/
* https://docs.requirementyogi.com/data-center/rest-api

If you think interesting to do script in python, I can try add into wrapper atlassian-python-api .

Mileva Briand · Accepted Answer

Hey @Sebastien Legate , and thanks @Gonchik Tsymzhitov for your answer.

Just to let you know directly from the team: we are not planning to change the requirement's format and it is very unlikely that we ever do it. If we still do, it will definitely be a major update.

Also, small mention, if you want to be notified for new releases on Data Center, you can join our mailing list 😉

Have a nice week,

Mileva (Requirement Yogi)