Backup_Repos/komga
1
0
Fork 0
mirror of https://github.com/gotson/komga.git synced 2025-12-30 04:12:51 +01:00
Code Issues Projects Releases Wiki Activity

docs(api): add replacement for deprecated APIs

Browse source
This commit is contained in:
Gauthier Roebroeck 2025-02-07 17:22:14 +08:00
parent c423d7cd8e
commit fab59bced9
3 changed files with 7 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
komga/src/main/kotlin/org/gotson/komga/interfaces/api/rest/BookController.kt
View file

@ -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,

4
komga/src/main/kotlin/org/gotson/komga/interfaces/api/rest/LibraryController.kt
View file

@ -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

3
komga/src/main/kotlin/org/gotson/komga/interfaces/api/rest/SeriesController.kt
View file

@ -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,