improve example and tests

Author: SMILEY4

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

@@ -51,6 +51,7 @@ private fun Application.myModule() {
 
     routing {
 
+        // add the routes for  the api-spec, swagger-ui and redoc
         route("api.json") {
             openApi()
         }
@@ -61,19 +62,21 @@ private fun Application.myModule() {
             redoc("/api.json")
         }
 
-        get<PetsRoute.All>({
-            description = "custom description"
-            request {
-                queryParameter<String>("tags") {
-                    description = "sample description"
-                }
-            }
-        }) { request ->
+        // query and path parameters are picked up automatically and added to the schema with the correct name and type
+        get<PetsRoute.All> { request ->
             println("..${request.tags}, ${request.limit}")
             call.respond(HttpStatusCode.NotImplemented, Unit)
         }
 
-        get<PetsRoute.Id> { request ->
+        // additional information can be added to the route manually as usual.
+        // automatically added information can also be overwritten this way.
+        get<PetsRoute.Id>({
+            request {
+                pathParameter<Long>("id") {
+                    description = "the id of the pet"
+                }
+            }
+        }) { request ->
             println("..${request.id}")
             call.respond(HttpStatusCode.NotImplemented, Unit)
         }
@@ -99,7 +102,7 @@ class PetsRoute {
     @Resource("/")
     class All(
         val parent: PetsRoute,
-        val tags: List<String> = emptyList(),
+        val tags: List<String>?,
         val limit: Int = 100
     )
 

ktor-openapi/src/main/kotlin/io/github/smiley4/ktoropenapi/resources/documentationExtractor.kt

@@ -48,12 +48,17 @@ private fun collectParameters(descriptor: SerialDescriptor, path: String): List<
         if (!elementDescriptor.isInline && elementDescriptor.kind is StructureKind.CLASS) {
             parameters.addAll(collectParameters(elementDescriptor, path))
         } else {
+            val location = getLocation(name, path)
             parameters.add(
                 ParameterData(
                     name = name,
                     descriptor = elementDescriptor,
-                    optional = path.contains("{$name?}"),
-                    location = getLocation(name, path)
+                    optional = when(location) {
+                        ParameterLocation.PATH -> path.contains("{$name?}")
+                        ParameterLocation.QUERY -> elementDescriptor.isNullable || descriptor.isElementOptional(index)
+                        else -> false
+                    },
+                    location = location
                 )
             )
         }

ktor-openapi/src/test/kotlin/io/github/smiley4/ktorswaggerui/misc/RouteDocumentationMergerTest.kt

@@ -103,7 +103,6 @@ class RouteDocumentationMergerTest : StringSpec({
                     "query",
                     "pathA1",
                     "pathA2",
-                    "query",
                     "pathB1",
                     "pathB2"
                 )