add 'hidden'-property to request parameters and responses

Author: SMILEY4

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

@@ -24,7 +24,9 @@ internal class OperationBuilder(
             it.operationId = route.documentation.operationId
             it.deprecated = route.documentation.deprecated
             it.tags = operationTagsBuilder.build(route)
-            it.parameters = route.documentation.request.parameters.map { param -> parameterBuilder.build(param) }
+            it.parameters = route.documentation.request.parameters
+                .filter { param -> !param.hidden }
+                .map { param -> parameterBuilder.build(param) }
             route.documentation.request.body?.let { body ->
                 it.requestBody = requestBodyBuilder.build(body)
             }

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

@@ -17,6 +17,7 @@ internal class ResponsesBuilder(
     fun build(responses: List<ResponseData>, isProtected: Boolean): ApiResponses =
         ApiResponses().also {
             responses
+                .filter { !it.hidden }
                 .map { response -> responseBuilder.build(response) }
                 .forEach { (name, response) -> it.addApiResponse(name, response) }
             if (shouldAddUnauthorized(responses, isProtected)) {
@@ -29,6 +30,7 @@ internal class ResponsesBuilder(
     private fun shouldAddUnauthorized(responses: List<ResponseData>, isProtected: Boolean): Boolean {
         val unauthorizedCode = HttpStatusCode.Unauthorized.value.toString()
         return config.securityConfig.defaultUnauthorizedResponse != null
+                && !config.securityConfig.defaultUnauthorizedResponse.hidden
                 && isProtected
                 && responses.count { it.statusCode == unauthorizedCode } == 0
     }

ktor-openapi/src/main/kotlin/io/github/smiley4/ktoropenapi/builder/route/RouteDocumentationMerger.kt

@@ -1,5 +1,7 @@
 package io.github.smiley4.ktoropenapi.builder.route
 
+import io.github.smiley4.ktoropenapi.config.RequestConfig
+import io.github.smiley4.ktoropenapi.config.RequestParameterConfig
 import io.github.smiley4.ktoropenapi.config.RouteConfig
 
 internal class RouteDocumentationMerger {
@@ -10,7 +12,7 @@ internal class RouteDocumentationMerger {
     fun merge(a: RouteConfig, b: RouteConfig): RouteConfig {
         return RouteConfig().apply {
             specName = a.specName ?: b.specName
-            tags = mutableListOf<String>().also {
+            tags = mutableSetOf<String>().also {
                 it.addAll(a.tags)
                 it.addAll(b.tags)
             }
@@ -25,15 +27,17 @@ internal class RouteDocumentationMerger {
             hidden = a.hidden || b.hidden
             protected = a.protected ?: b.protected
             request {
-                parameters.also {
-                    it.addAll(a.getRequest().parameters)
-                    it.addAll(b.getRequest().parameters)
-                }
+                buildMap {
+                    b.getRequest().parameters.forEach { this[it.name] = it }
+                    a.getRequest().parameters.forEach { this[it.name] = it }
+                }.values.forEach { parameters.add(it) }
                 setBody(a.getRequest().getBody() ?: b.getRequest().getBody())
             }
             response {
-                b.getResponses().getResponses().forEach { response -> addResponse(response) }
-                a.getResponses().getResponses().forEach { response -> addResponse(response) }
+                buildMap {
+                    b.getResponses().getResponses().forEach { this[it.statusCode] = it }
+                    a.getResponses().getResponses().forEach { this[it.statusCode] = it }
+                }.values.forEach { addResponse(it) }
             }
         }
     }

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

@@ -34,18 +34,21 @@ class RequestParameterConfig(
      */
     var example: ExampleDescriptor? = null
 
+
     /**
      * An example value for this parameter
      */
     fun example(example: ExampleDescriptor) {
         this.example = example
     }
 
+
     /**
      * An example value for this parameter
      */
     fun example(name: String, example: Example) = example(SwaggerExampleDescriptor(name, example))
 
+
     /**
      * An example value for this parameter
      */
@@ -101,6 +104,13 @@ class RequestParameterConfig(
      */
     var style: Parameter.StyleEnum? = null
 
+
+    /**
+     * Don't include this parameter in the openapi-spec
+     */
+    var hidden: Boolean = false
+
+
     /**
      * Build the data object for this config.
      */
@@ -115,7 +125,8 @@ class RequestParameterConfig(
         allowEmptyValue = allowEmptyValue,
         explode = explode ?: false,
         allowReserved = allowReserved,
-        style = style
+        style = style,
+        hidden = hidden
     )
 
 }

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

@@ -59,37 +59,46 @@ class ResponseConfig(val statusCode: String) {
         body = SimpleBodyConfig(type).apply(block)
     }
 
+
     /**
      * The body returned with this response
      */
     fun body(type: Schema<*>, block: SimpleBodyConfig.() -> Unit = {}) = body(SwaggerTypeDescriptor(type), block)
 
+
     /**
      * The body returned with this response
      */
     fun body(type: KType, block: SimpleBodyConfig.() -> Unit = {}) = body(KTypeDescriptor(type), block)
 
+
     /**
      * The body returned with this response
      */
     inline fun <reified T> body(noinline block: SimpleBodyConfig.() -> Unit = {}) = body(KTypeDescriptor(typeOf<T>()), block)
 
 
-
-
     /**
      * The multipart-body returned with this response
      */
     fun multipartBody(block: MultipartBodyConfig.() -> Unit) {
         body = MultipartBodyConfig().apply(block)
     }
 
+
+    /**
+     * Don't include this response in the openapi-spec
+     */
+    var hidden: Boolean = false
+
+
     /**
      * Build the data object for this config.
      */
     internal fun build() = ResponseData(
         statusCode = statusCode,
         description = description,
+        hidden = hidden,
         headers = headers.mapValues { it.value.build() },
         body = body?.build()
     )

ktor-openapi/src/main/kotlin/io/github/smiley4/ktoropenapi/data/RequestParameterData.kt

@@ -20,4 +20,5 @@ internal data class RequestParameterData(
     val explode: Boolean,
     val allowReserved: Boolean?,
     val style: Parameter.StyleEnum?,
+    val hidden: Boolean,
 )

ktor-openapi/src/main/kotlin/io/github/smiley4/ktoropenapi/data/ResponseData.kt

@@ -6,6 +6,7 @@ package io.github.smiley4.ktoropenapi.data
 internal data class ResponseData(
     val statusCode: String,
     val description: String?,
+    val hidden: Boolean,
     val headers: Map<String, HeaderData>,
     val body: BaseBodyData?,
 )

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

@@ -24,7 +24,6 @@ fun <T> extractTypesafeDocumentation(serializer: KSerializer<T>, resourcesFormat
     if(!OpenApiPlugin.config.autoDocumentResourcesRoutes) {
         return {}
     }
-
     // Note: typesafe routing only defines information about path & query parameters - no other information is available
     val path = resourcesFormat.encodeToPathPattern(serializer)
     return {