Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
4 tasks
corneliusroemer opened this issue Sep 16, 2024 · 0 comments
Labels
backend related to the loculus backend component codesmell For warnings/lints without immediate harm but to be fixed eventually documentation Improvements or additions to documentation refactoring Code requires refactoring

Comments

@corneliusroemer
Copy link
Contributor

@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:

  • Indicate authentication requirements correctly
  • Grouping into logical sections (submission vs. getting data vs groups vs preprocessing etc)
  • Public vs private (endpoints for certain privileged users, e.g. preprocessing)
  • Stable vs unstable APIs (the ones that we think people shouldn't [want to/have to] use we mark as unstable)
@corneliusroemer corneliusroemer added documentation Improvements or additions to documentation backend related to the loculus backend component refactoring Code requires refactoring codesmell For warnings/lints without immediate harm but to be fixed eventually labels Sep 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend related to the loculus backend component codesmell For warnings/lints without immediate harm but to be fixed eventually documentation Improvements or additions to documentation refactoring Code requires refactoring
Projects
None yet
Development

No branches or pull requests

1 participant