bihealth / sodar-server

SODAR: System for Omics Data Access and Retrieval

Home Page:https://github.com/bihealth/sodar-server

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Update REST API versioning for SODAR Core v1.0

mikkonie opened this issue · comments

To be done after/during #1922.

REST API versioning will be changed in SODAR Core v1.0.0, see bihealth/sodar-core#1278.

These changes need to be also done for SODAR apps. This will sadly be a breaking change, as deprecating the old versioning and providing a temporary workaround would IMHO not be worth the effort.

API calls without strict versioning will continue to work as usual, as URLs are not affected. My hunch is that most clients haven't even bothered to set up versioning, but I could be wrong..

Tasks

  • Add versioning for samplesheets
  • Add versioning for landingzones
  • Add versioning for irodsinfo
  • Update API docs for each app
  • Mention breaking change in release notes
  • Remove SODAR_API_* settings (exception: SODAR_API_DEFAULT_HOST)
  • Update release_cleanup.md regarding versioning