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

Upgrade API spec to OpenAPI 3 #644

Closed
osma opened this issue Nov 18, 2022 · 0 comments · Fixed by #649
Closed

Upgrade API spec to OpenAPI 3 #644

osma opened this issue Nov 18, 2022 · 0 comments · Fixed by #649
Assignees
Milestone

Comments

@osma
Copy link
Member

osma commented Nov 18, 2022

Annif uses Connexion to provide the REST API based on a spec file. The current spec file annif.yaml is written following the Swagger 2.0 specification. But this is quite obsolete, as its successor OpenAPI 3.0 was released already in 2017.

We should convert the spec file to OpenAPI 3.0 and probably also switch the name of the directory it resides in from swagger to openapi.

I already tried this, using Swagger Editor for conversion, but the converted version didn't seem to work - it gives a bunch of validation errors when I try to use annif run or run unit tests.

@osma osma self-assigned this Nov 18, 2022
@osma osma added this to the 0.60 milestone Nov 25, 2022
@osma osma closed this as completed in #649 Nov 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant