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

Update DataGateway API OpenAPI/Swagger Docs to ICAT Backend #347

Open
2 tasks
MRichards99 opened this issue Feb 28, 2022 · 0 comments
Open
2 tasks

Update DataGateway API OpenAPI/Swagger Docs to ICAT Backend #347

MRichards99 opened this issue Feb 28, 2022 · 0 comments
Labels
db backend Issues relating to the DB backend icat backend Issues relating to the Python ICAT backend

Comments

@MRichards99
Copy link
Collaborator

Description:
For DataGateway API, we use the OpenAPI specification to document the API. This implementation is in itself slightly tailored to the database backend, but for the most part explains the API well.

The database and ICAT backends have differences, mainly with the field names. Since the database backend isn't being used in production, most users will use the ICAT backend due to the additional features it may bring.

The OpenAPI docs should be updated for the ICAT backend, using Python ICAT to generate the fields etc. Ideally, the OpenAPI interface for DataGateway API should be generated depending on the backend being used. This way, the existing code won't go to waste and all the use cases will be covered (i.e. the docs will be accurate for both backends).

I'm not sure how many people use the Swagger interface, so I don't think this is particularly high priority.

Acceptance criteria:

  • Check that the existing OpenAPI docs match DataGateway API's Python ICAT backend. Make changes as needed, this backend should be prioritised over the database backend
  • If possible, determine which backend is being used and use the appropriate code/docs (i.e. existing code/docs for DB backend, new docs for ICAT backend)
@MRichards99 MRichards99 added db backend Issues relating to the DB backend icat backend Issues relating to the Python ICAT backend labels Feb 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
db backend Issues relating to the DB backend icat backend Issues relating to the Python ICAT backend
Projects
None yet
Development

No branches or pull requests

1 participant