Docs improvements (#359)

* Use Array since Javalin OpenAPI requires it to read the list generics

* Use custom Pager class for documentation
This commit is contained in:
Mitchell Syer
2022-05-21 06:12:10 -04:00
committed by GitHub
parent a6d012abd9
commit 5b0426a94c
6 changed files with 17 additions and 11 deletions

View File

@@ -14,7 +14,7 @@ import suwayomi.tachidesk.manga.impl.update.IUpdater
import suwayomi.tachidesk.manga.impl.update.UpdateStatus
import suwayomi.tachidesk.manga.impl.update.UpdaterSocket
import suwayomi.tachidesk.manga.model.dataclass.CategoryDataClass
import suwayomi.tachidesk.manga.model.dataclass.MangaDataClass
import suwayomi.tachidesk.manga.model.dataclass.MangaChapterDataClass
import suwayomi.tachidesk.manga.model.dataclass.PaginatedList
import suwayomi.tachidesk.server.JavalinSetup.future
import suwayomi.tachidesk.server.util.formParam
@@ -49,10 +49,16 @@ object UpdateController {
)
},
withResults = {
json<PaginatedList<MangaDataClass>>(HttpCode.OK)
json<PagedMangaChapterListDataClass>(HttpCode.OK)
}
)
/**
* Class made for handling return type in the documentation for [recentChapters],
* since OpenApi cannot handle runtime generics.
*/
private class PagedMangaChapterListDataClass : PaginatedList<MangaChapterDataClass>(emptyList(), false)
val categoryUpdate = handler(
formParam<Int?>("categoryId"),
documentWith = {