From 9dcdb1df0369579cb878c7d4da95fc14aa4c3792 Mon Sep 17 00:00:00 2001 From: Gauthier Roebroeck Date: Tue, 18 Feb 2025 11:55:06 +0800 Subject: [PATCH] docs(api): update openapi description --- .../komga/infrastructure/swagger/OpenApiConfiguration.kt | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/komga/src/main/kotlin/org/gotson/komga/infrastructure/swagger/OpenApiConfiguration.kt b/komga/src/main/kotlin/org/gotson/komga/infrastructure/swagger/OpenApiConfiguration.kt index 4804fc2d..81b501bc 100644 --- a/komga/src/main/kotlin/org/gotson/komga/infrastructure/swagger/OpenApiConfiguration.kt +++ b/komga/src/main/kotlin/org/gotson/komga/infrastructure/swagger/OpenApiConfiguration.kt @@ -65,7 +65,14 @@ class OpenApiConfiguration( .version(appVersion) .description( """ - Komga RESTful API. + Komga REST API. + + ## Reference + + Check the API reference: + - on the [Komga website](https://komga.org/docs/category/api-reference) + - on any running Komga instance at `/swagger-ui.html` + - on [GitHub](https://raw.githubusercontent.com/gotson/komga/refs/heads/master/komga/docs/openapi.json) ## Authentication