document all endpoints (#350)

* Document all endpoints

* Forgot about global endpoints

server/src/main/kotlin/suwayomi/tachidesk/manga/controller/DownloadController.kt

@@ -7,10 +7,13 @@ package suwayomi.tachidesk.manga.controller
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
 
-import io.javalin.http.Context
+import io.javalin.http.HttpCode
 import io.javalin.websocket.WsConfig
 import suwayomi.tachidesk.manga.impl.download.DownloadManager
 import suwayomi.tachidesk.server.JavalinSetup.future
+import suwayomi.tachidesk.server.util.handler
+import suwayomi.tachidesk.server.util.pathParam
+import suwayomi.tachidesk.server.util.withOperation
 
 object DownloadController {
     /** Download queue stats */
@@ -28,45 +31,100 @@ object DownloadController {
     }
 
     /** Start the downloader */
-    fun start(ctx: Context) {
-        DownloadManager.start()
+    val start = handler(
+        documentWith = {
+            withOperation {
+                summary("Downloader start")
+                description("Start the downloader")
+            }
+        },
+        behaviorOf = { ctx ->
+            DownloadManager.start()
 
-        ctx.status(200)
-    }
+            ctx.status(200)
+        },
+        withResults = {
+            httpCode(HttpCode.OK)
+        }
+    )
 
     /** Stop the downloader */
-    fun stop(ctx: Context) {
-        DownloadManager.stop()
+    val stop = handler(
+        documentWith = {
+            withOperation {
+                summary("Downloader stop")
+                description("Stop the downloader")
+            }
+        },
+        behaviorOf = { ctx ->
+            DownloadManager.stop()
 
-        ctx.status(200)
-    }
+            ctx.status(200)
+        },
+        withResults = {
+            httpCode(HttpCode.OK)
+        }
+    )
 
     /** clear download queue */
-    fun clear(ctx: Context) {
-        DownloadManager.clear()
+    val clear = handler(
+        documentWith = {
+            withOperation {
+                summary("Downloader clear")
+                description("Clear download queue")
+            }
+        },
+        behaviorOf = { ctx ->
+            DownloadManager.clear()
 
-        ctx.status(200)
-    }
+            ctx.status(200)
+
+        },
+        withResults = {
+            httpCode(HttpCode.OK)
+        }
+    )
 
     /** Queue chapter for download */
-    fun queueChapter(ctx: Context) {
-        val chapterIndex = ctx.pathParam("chapterIndex").toInt()
-        val mangaId = ctx.pathParam("mangaId").toInt()
-
-        ctx.future(
-            future {
-                DownloadManager.enqueue(chapterIndex, mangaId)
+    val queueChapter = handler(
+        pathParam<Int>("chapterIndex"),
+        pathParam<Int>("mangaId"),
+        documentWith = {
+            withOperation {
+                summary("Downloader add chapter")
+                description("Queue chapter for download")
             }
-        )
-    }
+        },
+        behaviorOf = { ctx, chapterIndex, mangaId ->
+            ctx.future(
+                future {
+                    DownloadManager.enqueue(chapterIndex, mangaId)
+                }
+            )
+        },
+        withResults = {
+            httpCode(HttpCode.OK)
+            httpCode(HttpCode.NOT_FOUND)
+        }
+    )
 
     /** delete chapter from download queue */
-    fun unqueueChapter(ctx: Context) {
-        val chapterIndex = ctx.pathParam("chapterIndex").toInt()
-        val mangaId = ctx.pathParam("mangaId").toInt()
+    val unqueueChapter = handler(
+        pathParam<Int>("chapterIndex"),
+        pathParam<Int>("mangaId"),
+        documentWith = {
+            withOperation {
+                summary("Downloader remove chapter")
+                description("Delete chapter from download queue")
+            }
+        },
+        behaviorOf = { ctx, chapterIndex, mangaId ->
+            DownloadManager.unqueue(chapterIndex, mangaId)
 
-        DownloadManager.unqueue(chapterIndex, mangaId)
-
-        ctx.status(200)
-    }
+            ctx.status(200)
+        },
+        withResults = {
+            httpCode(HttpCode.OK)
+        }
+    )
 }