OpenAPI Documentation + Kotlin DSL #249
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This continues #248 using a custom DSL that will help us write the endpoint documentation.
I tested the DSL on the manga retrieve endpoint and it works perfectly. I did not add any of the updates endpoint documentation, that can be done at a later time.
Description of previous PR:
Added https://javalin.io/plugins/openapi to Tachidesk.
There are now two new paths available:
OpenApi isn't able to document WebSockets as of now.
I fully documented the UpdateController using the dsl API. Which provides flexibility in the placement of the documentation.