From fab59bced9ce838edb5d2312ae6858cff1b75d4d Mon Sep 17 00:00:00 2001
From: Gauthier Roebroeck <gauthier.roebroeck@gmail.com>
Date: Fri, 7 Feb 2025 17:22:14 +0800
Subject: [PATCH] docs(api): add replacement for deprecated APIs

---
 .../org/gotson/komga/interfaces/api/rest/BookController.kt    | 1 +
 .../org/gotson/komga/interfaces/api/rest/LibraryController.kt | 4 +++-
 .../org/gotson/komga/interfaces/api/rest/SeriesController.kt  | 3 +++
 3 files changed, 7 insertions(+), 1 deletion(-)

diff --git a/komga/src/main/kotlin/org/gotson/komga/interfaces/api/rest/BookController.kt b/komga/src/main/kotlin/org/gotson/komga/interfaces/api/rest/BookController.kt
index 7d0c465a9..cd405f1d5 100644
--- a/komga/src/main/kotlin/org/gotson/komga/interfaces/api/rest/BookController.kt
+++ b/komga/src/main/kotlin/org/gotson/komga/interfaces/api/rest/BookController.kt
@@ -118,6 +118,7 @@ class BookController(
   @Deprecated("use /v1/books/list instead")
   @PageableAsQueryParam
   @GetMapping("api/v1/books")
+  @Operation(summary = "Use POST /api/v1/books/list instead")
   fun getAllBooks(
     @AuthenticationPrincipal principal: KomgaPrincipal,
     @RequestParam(name = "search", required = false) searchTerm: String? = null,
diff --git a/komga/src/main/kotlin/org/gotson/komga/interfaces/api/rest/LibraryController.kt b/komga/src/main/kotlin/org/gotson/komga/interfaces/api/rest/LibraryController.kt
index 1b789d7e8..60e21ebca 100644
--- a/komga/src/main/kotlin/org/gotson/komga/interfaces/api/rest/LibraryController.kt
+++ b/komga/src/main/kotlin/org/gotson/komga/interfaces/api/rest/LibraryController.kt
@@ -1,5 +1,6 @@
 package org.gotson.komga.interfaces.api.rest
 
+import io.swagger.v3.oas.annotations.Operation
 import io.swagger.v3.oas.annotations.Parameter
 import jakarta.validation.Valid
 import org.gotson.komga.application.tasks.HIGHEST_PRIORITY
@@ -128,7 +129,8 @@ class LibraryController(
   @PutMapping("/{libraryId}")
   @PreAuthorize("hasRole('ADMIN')")
   @ResponseStatus(HttpStatus.NO_CONTENT)
-  @Deprecated("Use PATCH /v1/library instead", ReplaceWith("patchOne"))
+  @Deprecated("Use PATCH /v1/libraries/{libraryId} instead", ReplaceWith("patchOne"))
+  @Operation(summary = "Use PATCH /api/v1/libraries/{libraryId} instead")
   fun updateOne(
     @PathVariable libraryId: String,
     @Valid @RequestBody
diff --git a/komga/src/main/kotlin/org/gotson/komga/interfaces/api/rest/SeriesController.kt b/komga/src/main/kotlin/org/gotson/komga/interfaces/api/rest/SeriesController.kt
index 938bea883..de5e712e3 100644
--- a/komga/src/main/kotlin/org/gotson/komga/interfaces/api/rest/SeriesController.kt
+++ b/komga/src/main/kotlin/org/gotson/komga/interfaces/api/rest/SeriesController.kt
@@ -131,6 +131,7 @@ class SeriesController(
     ),
   )
   @GetMapping("v1/series")
+  @Operation(summary = "Use POST /api/v1/series/list instead")
   fun getAllSeries(
     @AuthenticationPrincipal principal: KomgaPrincipal,
     @RequestParam(name = "search", required = false) searchTerm: String? = null,
@@ -262,6 +263,7 @@ class SeriesController(
     ),
   )
   @GetMapping("v1/series/alphabetical-groups")
+  @Operation(summary = "Use POST /api/v1/series/list/alphabetical-groups instead")
   fun getAlphabeticalGroups(
     @AuthenticationPrincipal principal: KomgaPrincipal,
     @RequestParam(name = "search", required = false) searchTerm: String?,
@@ -565,6 +567,7 @@ class SeriesController(
   @PageableAsQueryParam
   @AuthorsAsQueryParam
   @GetMapping("v1/series/{seriesId}/books")
+  @Operation(summary = "Use POST /api/v1/books/list instead")
   fun getAllBooksBySeries(
     @AuthenticationPrincipal principal: KomgaPrincipal,
     @PathVariable(name = "seriesId") seriesId: String,