Merge branch 'develop' into release

Author: SMILEY4

docs/changelog.md

@@ -5,6 +5,18 @@ search:
 
 # Changelog
 
+## 5.3.0
+
+- fix kotlinx-serialization example encoding [#212](https://github.com/SMILEY4/ktor-openapi-tools/issues/212)
+- fix missing response bodies from documented resources routes [#209](https://github.com/SMILEY4/ktor-openapi-tools/issues/209)
+- upgrade schema-kenerator from 2.3.0 to [2.4.0](https://github.com/SMILEY4/schema-kenerator/releases/tag/2.4.0)
+- upgrade ktor from 3.1.1 to ktor 3.3.0
+
+## 5.2.0
+
+- upgrade schema-kenerator from 2.1.3 to [2.3.0](https://github.com/SMILEY4/schema-kenerator/releases/tag/2.3.0)
+- fix handling of different OpenApi specs with multiple ktor modules
+
 ## 5.1.0
 
 - upgrade schema-kenerator to [2.1.3](https://github.com/SMILEY4/schema-kenerator/releases/tag/2.1.3)

examples/src/main/kotlin/io/github/smiley4/ktoropenapi/examples/TypesafeRouting.kt

@@ -81,13 +81,15 @@ private fun Application.myModule() {
             call.respond(HttpStatusCode.NotImplemented, Unit)
         }
 
+        // delete route
         delete<PetsRoute.Id.Delete> { request ->
             println("..${request.parent.id}")
             call.respond(HttpStatusCode.NotImplemented, Unit)
         }
 
-        post<PetsRoute.Id.New> { request ->
-            println("..${request.parent.id}")
+        // post with request body. Request body is added to the schema automatically.
+        post<PetsRoute.Id.New, Pet> { request, body ->
+            println("..${request.parent.id} $body")
             call.respond(HttpStatusCode.NotImplemented, Unit)
         }
 

gradle.properties

@@ -2,7 +2,7 @@ kotlin.code.style=official
 
 # project id
 projectGroupId=io.github.smiley4
-projectVersion=5.2.0
+projectVersion=5.3.0
 
 # common publishing information
 projectBaseScmUrl=https://github.com/SMILEY4/
@@ -13,10 +13,10 @@ projectDeveloperName=smiley4
 projectDeveloperUrl=https://github.com/SMILEY4
 
 # dependency versions
-versionKtor=3.1.1
+versionKtor=3.2.3
 versionSwaggerUI=5.17.14
 versionSwaggerParser=2.1.24
-versionSchemaKenerator=2.3.0
+versionSchemaKenerator=2.4.0
 versionKotlinLogging=7.0.0
 versionKotest=5.8.0
 versionKotlinTest=2.0.21

ktor-openapi/src/main/kotlin/io/github/smiley4/ktoropenapi/builder/example/ExampleContextImpl.kt

@@ -82,7 +82,7 @@ internal class ExampleContextImpl(private val encoder: GenericExampleEncoder) :
     private fun generateExample(exampleDescriptor: ExampleDescriptor, type: TypeDescriptor?): Example {
         return when (exampleDescriptor) {
             is ValueExampleDescriptor -> Example().also {
-                it.value = encoder(type, exampleDescriptor.value)
+                it.value = encoder(type ?: exampleDescriptor.type, exampleDescriptor.value)
                 it.summary = exampleDescriptor.summary
                 it.description = exampleDescriptor.description
             }

ktor-openapi/src/main/kotlin/io/github/smiley4/ktoropenapi/config/ExampleConfig.kt

@@ -1,13 +1,15 @@
 package io.github.smiley4.ktoropenapi.config
 
 import io.github.smiley4.ktoropenapi.config.descriptors.ExampleDescriptor
+import io.github.smiley4.ktoropenapi.config.descriptors.KTypeDescriptor
 import io.github.smiley4.ktoropenapi.config.descriptors.SwaggerExampleDescriptor
 import io.github.smiley4.ktoropenapi.config.descriptors.ValueExampleDescriptor
 import io.github.smiley4.ktoropenapi.data.ExampleConfigData
 import io.github.smiley4.ktoropenapi.data.MultipartBodyData
 import io.github.smiley4.ktoropenapi.data.SecurityData
 import io.github.smiley4.ktoropenapi.data.SimpleBodyData
 import io.swagger.v3.oas.models.examples.Example
+import kotlin.reflect.typeOf
 
 
 /**
@@ -43,15 +45,16 @@ class ExampleConfig internal constructor() {
      * Add a shared example that can be referenced by all routes by the given name.
      * The provided name has to be unique among all shared examples and acts as its id.
      */
-    fun example(name: String, example: ValueExampleDescriptorConfig.() -> Unit) = example(
-        ValueExampleDescriptorConfig()
+    inline fun <reified T> example(name: String, example: ValueExampleDescriptorConfig<T>.() -> Unit) = example(
+        ValueExampleDescriptorConfig<T>()
             .apply(example)
             .let { result ->
                 ValueExampleDescriptor(
                     name = name,
                     value = result.value,
                     summary = result.summary,
-                    description = result.description
+                    description = result.description,
+                    type = KTypeDescriptor(typeOf<T>())
                 )
             }
     )

ktor-openapi/src/main/kotlin/io/github/smiley4/ktoropenapi/config/RequestParameterConfig.kt

@@ -1,12 +1,14 @@
 package io.github.smiley4.ktoropenapi.config
 
 import io.github.smiley4.ktoropenapi.config.descriptors.ExampleDescriptor
+import io.github.smiley4.ktoropenapi.config.descriptors.KTypeDescriptor
 import io.github.smiley4.ktoropenapi.config.descriptors.SwaggerExampleDescriptor
 import io.github.smiley4.ktoropenapi.config.descriptors.ValueExampleDescriptor
 import io.github.smiley4.ktoropenapi.config.descriptors.TypeDescriptor
 import io.github.smiley4.ktoropenapi.data.RequestParameterData
 import io.swagger.v3.oas.models.examples.Example
 import io.swagger.v3.oas.models.parameters.Parameter
+import kotlin.reflect.typeOf
 
 /**
  * Describes a single request parameter.
@@ -56,15 +58,16 @@ class RequestParameterConfig internal constructor(
     /**
      * An example value for this parameter
      */
-    fun example(name: String, example: ValueExampleDescriptorConfig.() -> Unit) = example(
-        ValueExampleDescriptorConfig()
+    inline fun <reified T> example(name: String, example: ValueExampleDescriptorConfig<T>.() -> Unit) = example(
+        ValueExampleDescriptorConfig<T>()
             .apply(example)
             .let { result ->
                 ValueExampleDescriptor(
                     name = name,
                     value = result.value,
                     summary = result.summary,
-                    description = result.description
+                    description = result.description,
+                    type = KTypeDescriptor(typeOf<T>())
                 )
             }
     )

ktor-openapi/src/main/kotlin/io/github/smiley4/ktoropenapi/config/SchemaGenerator.kt

@@ -261,7 +261,6 @@ object SchemaGenerator {
             type
                 .analyzeTypeUsingKotlinxSerialization {
                     serializersModule = configInstance.serializersModule
-                    knownNotParameterized = configInstance.knownNotParameterized
                     customModules.addAll(configInstance.analyzerModules)
                 }
                 .addJsonClassDiscriminatorProperty()
@@ -306,35 +305,39 @@ object SchemaGenerator {
          * The types that are guaranteed to not have type parameters.
          * This helps the type processing step to determine whether two types are truly the same and may fix issues encountered with types.
          */
+        @Deprecated("unused")
         var knownNotParameterized = mutableSetOf<String>()
 
 
         /**
          * Mark the type with the given full/qualified name as "not parameterized", i.e. as not having any generic type parameters.
          * This helps the type processing step to determine whether two types are truly the same and may fix issues encountered with types.
          */
+        @Suppress("unused")
+        @Deprecated("unused")
         fun markNotParameterized(name: String) {
-            knownNotParameterized.add(name)
+            // does nothing anymore
         }
 
 
         /**
          * Mark the given type as "not parameterized", i.e as not having any generic type parameters.
          * This helps the type processing step to determine whether two types are truly the same and may fix issues encountered with types.
          */
+        @Suppress("unused")
+        @Deprecated("unused")
         fun markNotParameterized(type: KType) {
-            val clazz = type.classifier!! as KClass<*>
-            markNotParameterized(clazz.qualifiedName ?: clazz.java.name)
+            // does nothing anymore
         }
 
 
         /**
          * Mark the given type as "not parameterized", i.e as not having any generic type parameters.
          * This helps the type processing step to determine whether two types are truly the same.
          */
+        @Deprecated("unused")
         inline fun <reified T> markNotParameterized() {
-            val clazz = typeOf<T>().classifier!! as KClass<*>
-            markNotParameterized(clazz.qualifiedName ?: clazz.java.name)
+            // does nothing anymore
         }
 
         /**

ktor-openapi/src/main/kotlin/io/github/smiley4/ktoropenapi/config/SimpleBodyConfig.kt

@@ -1,12 +1,14 @@
 package io.github.smiley4.ktoropenapi.config
 
 import io.github.smiley4.ktoropenapi.config.descriptors.ExampleDescriptor
+import io.github.smiley4.ktoropenapi.config.descriptors.KTypeDescriptor
 import io.github.smiley4.ktoropenapi.config.descriptors.RefExampleDescriptor
 import io.github.smiley4.ktoropenapi.config.descriptors.SwaggerExampleDescriptor
 import io.github.smiley4.ktoropenapi.config.descriptors.ValueExampleDescriptor
 import io.github.smiley4.ktoropenapi.config.descriptors.TypeDescriptor
 import io.github.smiley4.ktoropenapi.data.SimpleBodyData
 import io.swagger.v3.oas.models.examples.Example
+import kotlin.reflect.typeOf
 
 
 /**
@@ -40,15 +42,16 @@ class SimpleBodyConfig internal constructor(
     /**
      * Add the given example as an example to this body
      */
-    fun example(name: String, example: ValueExampleDescriptorConfig.() -> Unit) = example(
-        ValueExampleDescriptorConfig()
+    inline fun <reified T> example(name: String, example: ValueExampleDescriptorConfig<T>.() -> Unit) = example(
+        ValueExampleDescriptorConfig<T>()
             .apply(example)
             .let { result ->
                 ValueExampleDescriptor(
                     name = name,
                     value = result.value,
                     summary = result.summary,
-                    description = result.description
+                    description = result.description,
+                    type = KTypeDescriptor(typeOf<T>())
                 )
             }
     )

ktor-openapi/src/main/kotlin/io/github/smiley4/ktoropenapi/config/ValueExampleDescriptorConfig.kt

@@ -1,11 +1,11 @@
 package io.github.smiley4.ktoropenapi.config
 
-class ValueExampleDescriptorConfig {
+class ValueExampleDescriptorConfig<T> {
 
     /**
      * the example value
      */
-    var value: Any? = null
+    var value: T? = null
 
 
     /**

ktor-openapi/src/main/kotlin/io/github/smiley4/ktoropenapi/config/descriptors/ExampleDescriptor.kt

@@ -18,6 +18,7 @@ class ValueExampleDescriptor(
     val value: Any?,
     val summary: String? = null,
     val description: String? = null,
+    val type: TypeDescriptor? = null,
 ) : ExampleDescriptor(name)