Merge branch 'bugfix/array-element-type-name' into release

Author: SMILEY4

build.gradle.kts

@@ -10,7 +10,7 @@ plugins {
 object Meta {
     const val groupId = "io.github.smiley4"
     const val artifactId = "ktor-swagger-ui"
-    const val version = "2.2.0"
+    const val version = "2.2.1"
     const val name = "Ktor Swagger-UI"
     const val description = "Ktor plugin to document routes and provide Swagger UI"
     const val licenseName = "The Apache License, Version 2.0"
@@ -27,6 +27,7 @@ version = Meta.version
 
 repositories {
     mavenCentral()
+    maven(url = "https://raw.githubusercontent.com/glureau/json-schema-serialization/mvn-repo")
 }
 
 dependencies {

src/main/kotlin/io/github/smiley4/ktorswaggerui/dsl/SchemaType.kt

@@ -16,10 +16,18 @@ fun SchemaType.getTypeName() = this.toString()
 
 fun SchemaType.getSimpleTypeName(): String {
     val rawName = getTypeName()
-    if(rawName.contains("<") || rawName.contains(">")) {
-        return rawName
+    return if (rawName.contains("<") || rawName.contains(">")) {
+        rawName
     } else {
-        return (this.classifier as KClass<*>).simpleName ?: rawName
+        (this.classifier as KClass<*>).simpleName ?: rawName
+    }
+}
+
+fun SchemaType.getSimpleArrayElementTypeName(): String {
+    if (this.arguments.size != 1 || this.arguments.first().type == null) {
+        throw IllegalArgumentException("Could not determine type of array-elements")
+    } else {
+        return this.arguments[0].type!!.getSimpleTypeName()
     }
 }
 

src/main/kotlin/io/github/smiley4/ktorswaggerui/spec/schema/SchemaContext.kt

@@ -3,6 +3,7 @@ package io.github.smiley4.ktorswaggerui.spec.schema
 import io.github.smiley4.ktorswaggerui.dsl.CustomSchemaRef
 import io.github.smiley4.ktorswaggerui.dsl.SchemaType
 import io.github.smiley4.ktorswaggerui.dsl.getSchemaType
+import io.github.smiley4.ktorswaggerui.dsl.getSimpleArrayElementTypeName
 import io.github.smiley4.ktorswaggerui.dsl.getSimpleTypeName
 import io.swagger.v3.oas.models.media.Schema
 import kotlin.collections.set
@@ -176,7 +177,7 @@ class SchemaContext {
         schemaDefinitions.definitions.forEach { (name, schema) ->
             addToComponentsSection(name, schema)
         }
-        val rootName = schemaName(key)
+        val rootName = getWrappedSchemaName(key)
         addToComponentsSection(rootName, schemaDefinitions.root.items)
         addInline(key, Schema<Any>().also { array ->
             array.type = "array"
@@ -194,6 +195,14 @@ class SchemaContext {
         }
     }
 
+    private fun getWrappedSchemaName(key: SchemaKeyWrapper): String {
+        return if (key.isCustom) {
+            key.schemaId
+        } else {
+            key.type.getSimpleArrayElementTypeName()
+        }
+    }
+
     private fun addToComponentsSection(name: String, schema: Schema<*>) {
         componentsSection[name] = schema
     }

src/test/kotlin/io/github/smiley4/ktorswaggerui/tests/schema/SchemaContextTest.kt

@@ -1,5 +1,11 @@
 package io.github.smiley4.ktorswaggerui.tests.schema
 
+import com.github.victools.jsonschema.generator.Option
+import com.github.victools.jsonschema.generator.OptionPreset
+import com.github.victools.jsonschema.generator.SchemaGenerator
+import com.github.victools.jsonschema.generator.SchemaGeneratorConfig
+import com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder
+import com.github.victools.jsonschema.generator.SchemaVersion
 import io.github.smiley4.ktorswaggerui.SwaggerUIPluginConfig
 import io.github.smiley4.ktorswaggerui.dsl.OpenApiRoute
 import io.github.smiley4.ktorswaggerui.dsl.array
@@ -18,6 +24,7 @@ import io.kotest.matchers.shouldBe
 import io.kotest.matchers.shouldNotBe
 import io.ktor.http.HttpMethod
 import io.swagger.v3.oas.models.media.Schema
+import kotlin.reflect.jvm.javaType
 
 class SchemaContextTest : StringSpec({
 
@@ -360,6 +367,51 @@ class SchemaContextTest : StringSpec({
         }
     }
 
+    "unwrap inlined array schema" {
+        val generator = SchemaGenerator(
+            SchemaGeneratorConfigBuilder(SchemaVersion.DRAFT_2019_09, OptionPreset.PLAIN_JSON)
+                .without(Option.DEFINITIONS_FOR_ALL_OBJECTS)
+                .with(Option.INLINE_ALL_SCHEMAS)
+                .with(Option.EXTRA_OPEN_API_FORMAT_VALUES)
+                .with(Option.ALLOF_CLEANUP_AT_THE_END)
+                .build()
+        )
+        val config = SwaggerUIPluginConfig().also {
+            it.encoding {
+                schemaEncoder { type ->
+                    generator.generateSchema(type.javaType).toString()
+                }
+            }
+        }
+        val routes = listOf(
+            route {
+                request {
+                    body<List<SimpleDataClass>>()
+                }
+            }
+        )
+        val schemaContext = schemaContext(routes, config)
+        schemaContext.getSchema(getSchemaType<List<SimpleDataClass>>()).also { schema ->
+            schema.type shouldBe "array"
+            schema.`$ref` shouldBe null
+            schema.items
+                .also { it shouldNotBe null }
+                ?.also { items ->
+                    items.`$ref` shouldBe "#/components/schemas/SimpleDataClass"
+                }
+        }
+        schemaContext.getComponentsSection().also { components ->
+            components.keys shouldContainExactlyInAnyOrder listOf(
+                "SimpleDataClass",
+            )
+            components["SimpleDataClass"]?.also { schema ->
+                schema.type shouldBe "object"
+                schema.properties.keys shouldContainExactlyInAnyOrder listOf("number", "text")
+            }
+        }
+    }
+
+
 }) {
 
     companion object {