Feature/#25 open api
Feature
Summary
This MR provides an OpenAPI documentation for the API at ahikar/openapi/index.html
.
❗ Important
I'm not sure where the Apache config is. ahikar/openapi/index.html
should be exposed to https://ahikar-dev.uni-goettingen.de/openapi (or somewhere else if you have an alternative).
Does the result of the MR comply to our "definition of done"?
-
I don't know
Use Cases
It's useful for Ahikar developers to get a better overview of the API as well as other people interested in sample implementation of the generic TextAPI.
Documentation
Shall we add your feature to the documentation?
-
I've already did it!
Are there parts of the documentation we have to adjust
-
No.
Tests
Are we able to test this new feature?
-
Yes, you can test by following these steps: Start the back end and navigate to ahikar/openapi/index.html
Changelog
-
I added a statement to the CHANGELOG.
Related Tickets
Closes
Edited by Michelle Weidling