There appears to exist an internal API endpoint that returns very lightweight data about releases (similar to /api/v1/releases/search, but the size of the responses is at least 90% smaller). Could we please have a public API version of that that allows for querying for releases but getting only high-level information about them?
As an example:
1. Querying via public API for all active releases gave me back a 39 MB response (approximately 65 releases)
2. Using the internal API to do the same query gave me a 106 KB response (for the same 65 releases)
Note for internal DAI resources: ENG-3048 was created in December of 2020 for this, but Paychex was encouraged to open this as an idea here.
by: Peter G. | about a year ago | API & CLI tools
Comments
Thank you, Peter for you request.
Can you provide further specifics on the data you would like to be made available through the API?
In what way and for what purpose do you intend to use this data?
We have a lot of automation the queries for basic Release information: creation details, state, title, etc. The internal API (like what is used to fill in the UI's Releases screen) appear to return that small amount of data. I could try coming up with the full list of each piece of information that we need, but I know that the internal API has at least everything we've been looking for, and comes back faster and smaller than having full release JSONs returned
Test comment just to see if Mason gets a notification, because I never do
In the Erawan (24.1) release cycle, our emphasis was on enhancing the performance of multiple pages, including the Release Overview page. Consequently, we will enhance ReleaseApi with methods that return more lightweight information about release object. This streamlined version of the API will include details about releases, such as ID, title, status, start and end dates, type, kind, and archived property.