From 47039bcd58357dec0e8ba525e1a4b332482411a1 Mon Sep 17 00:00:00 2001 From: Georg Echterling Date: Mon, 16 Sep 2024 18:31:55 +0200 Subject: [PATCH] fix: Missing descriptions on Kotlin ByteArray fields Fixes #2275 --- .../core/configuration/SpringDocKotlinConfiguration.kt | 1 - .../test/org/springdoc/api/app6/ByteArrayController.kt | 6 +++++- .../src/test/resources/results/app6.json | 1 + 3 files changed, 6 insertions(+), 2 deletions(-) diff --git a/springdoc-openapi-starter-common/src/main/java/org/springdoc/core/configuration/SpringDocKotlinConfiguration.kt b/springdoc-openapi-starter-common/src/main/java/org/springdoc/core/configuration/SpringDocKotlinConfiguration.kt index fc09e6465..ab1504574 100644 --- a/springdoc-openapi-starter-common/src/main/java/org/springdoc/core/configuration/SpringDocKotlinConfiguration.kt +++ b/springdoc-openapi-starter-common/src/main/java/org/springdoc/core/configuration/SpringDocKotlinConfiguration.kt @@ -44,7 +44,6 @@ class SpringDocKotlinConfiguration() { init { SpringDocUtils.getConfig() .addRequestWrapperToIgnore(Continuation::class.java) - .replaceWithSchema(ByteArray::class.java, ByteArraySchema()) .addDeprecatedType(Deprecated::class.java) } diff --git a/springdoc-openapi-tests/springdoc-openapi-kotlin-webflux-tests/src/test/kotlin/test/org/springdoc/api/app6/ByteArrayController.kt b/springdoc-openapi-tests/springdoc-openapi-kotlin-webflux-tests/src/test/kotlin/test/org/springdoc/api/app6/ByteArrayController.kt index f3de98487..9f201c3d7 100644 --- a/springdoc-openapi-tests/springdoc-openapi-kotlin-webflux-tests/src/test/kotlin/test/org/springdoc/api/app6/ByteArrayController.kt +++ b/springdoc-openapi-tests/springdoc-openapi-kotlin-webflux-tests/src/test/kotlin/test/org/springdoc/api/app6/ByteArrayController.kt @@ -18,11 +18,15 @@ package test.org.springdoc.api.app6 +import io.swagger.v3.oas.annotations.media.Schema import org.springframework.web.bind.annotation.GetMapping import org.springframework.web.bind.annotation.RequestMapping import org.springframework.web.bind.annotation.RestController -data class Foo(val data: ByteArray) +data class Foo( + @Schema(description = "Some description about a byte array.") + val data: ByteArray +) @RestController @RequestMapping("/bytearray") diff --git a/springdoc-openapi-tests/springdoc-openapi-kotlin-webflux-tests/src/test/resources/results/app6.json b/springdoc-openapi-tests/springdoc-openapi-kotlin-webflux-tests/src/test/resources/results/app6.json index 907da4426..dd4d0a41c 100644 --- a/springdoc-openapi-tests/springdoc-openapi-kotlin-webflux-tests/src/test/resources/results/app6.json +++ b/springdoc-openapi-tests/springdoc-openapi-kotlin-webflux-tests/src/test/resources/results/app6.json @@ -42,6 +42,7 @@ "properties": { "data": { "type": "string", + "description":"Some description about a byte array.", "format": "byte" } }