readthedocs.org icon indicating copy to clipboard operation
readthedocs.org copied to clipboard

Addons API: version last build date

Open agjohnson opened this issue 1 year ago • 2 comments
trafficstars

Raising this from a support request as a discussion for a potential API change on the addons. The use case here is showing the most recently built versions in the version data for a custom version menu or in the flyout. There are maybe two ways to approach this:

  • Add a version sorting option for most recently built versions
  • Add build date on the version responses in the API

I feel like the sorting could be optional and we will want to have the last build date on the version instances either way. The sorting mechanism will be prone to randomizing the version list for projects that have to go back and edit a release for any reason.

Front logo Front conversations

agjohnson avatar Apr 30 '24 16:04 agjohnson

The problem I see with either of the approaches listed here is that the endpoint wouldn't be able to be cached anymore. A build on any version will clear the cache for all the versions.

humitos avatar May 02 '24 10:05 humitos

Mmm good point. This does feel like a helpful feature for showing how fresh a version is, but not important enough to incur cache invalidation yet.

agjohnson avatar May 02 '24 15:05 agjohnson