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

Switch to OpenAPI #398

Open
tokee opened this issue Aug 9, 2023 · 1 comment
Open

Switch to OpenAPI #398

tokee opened this issue Aug 9, 2023 · 1 comment
Assignees
Labels
backend complex Complex issue that requires focus and/or in-depth knowledge

Comments

@tokee
Copy link
Contributor

tokee commented Aug 9, 2023

The SolrWayback frontend is separated from the backend using well defined webservice endpoints. As these endpoints can also be used by other applications, such as dashboards of analysis tools ("notebooks"), they should be properly defined with description, sample arguments etc.

OpenAPI is the obvious choice and writing a proper YAML for the existing endpoints seems like a straight forward task. However, switching it around so that the webservice specific parts of the code base is generated by OpenAPI instead of manually, will take some untangling and refactoring.

@tokee tokee added backend complex Complex issue that requires focus and/or in-depth knowledge labels Aug 9, 2023
@VictorHarbo
Copy link
Collaborator

Instead of turning everything around and converting to a design-first OpenAPI implementation, we could use swagger-core and throught it implement a code-first approach. I might take a look at how it works that way round.

@VictorHarbo VictorHarbo self-assigned this Jul 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend complex Complex issue that requires focus and/or in-depth knowledge
Projects
None yet
Development

No branches or pull requests

2 participants