Formalize OGRDB API with OpenAPI V3 spec

airr-knowledge / issues

Issues and project management for the AKC

0 stars 0 forks source link

Formalize OGRDB API with OpenAPI V3 spec #36

Closed schristley closed 2 weeks ago

schristley commented 8 months ago

AKC will primarily interact with OGRDB through a defined OpenAPI V3 spec.

[x] OpenAPI V3 spec file in GitHub repository, versioned and tagged.
[x] Request and response schemas linked to AIRR and/or CDM.
[x] Review and suggest any enhancements.

schristley commented 8 months ago

Hi @williamdlees , issue to track OGRDB API work. We should create one for VDJbase at some point, but might need more clarity on the data and its schema first.

schristley commented 7 months ago

Using pydantic to validate the outgoing response object sounds like a reasonable solution. There is a difference with how OpenAPI V2 and V3 defines request parameters, but it's not necessary for your flask middleware to use V3, you can "fake it" just by manually making sure the V3 spec and your flask code are in sync. Because your endpoints and request parameters are fairly simple, that manually sync'ing shouldn't be onerous.

schristley commented 2 weeks ago

Initial OGRDB API has been defined and is live.

schristley commented 2 weeks ago

[ ] Request and response schemas linked to AIRR and/or CDM.

These are currently linked to a local copy of AIRR openapi3 spec based upon the v1.5 release branch AIRR. This prevents the service from being disrupted if v1.5 release branch undergoes changes. We will want to integrate these better once we have more detailed processes about managing schema changes.