loculus-project / loculus

An open-source software package to power microbial genomic databases
https://loculus.org
GNU Affero General Public License v3.0
34 stars 1 forks source link

Make swagger UI sections more logical for API consumers: regroup and separate public/private endpoints #2805

Open corneliusroemer opened 3 days ago

corneliusroemer commented 3 days ago

@anna-parker and I just realized we'd independently been bothered by our swagger UI grouping being not very logical for API consumers, the current grouping is based on code organization, which is nothing API users should have to think about.

Certain backend APIs are written for public consumption (e.g. submission) while others are not really intended to be for public consumption (e.g. get original metadata). We should group things into stable and unstable APIs (private coming with no stability guarantees, if API users want them to become stable they should contact us).

Tasks: