Merge branch 'response-type-handling'

# Conflicts:
#	src/main/kotlin/io/openapiprocessor/core/writer/java/InterfaceWriter.kt
#	src/main/kotlin/io/openapiprocessor/core/writer/java/MethodWriter.kt

Author: hauner

src/main/kotlin/io/openapiprocessor/core/converter/ApiOptions.kt

@@ -6,6 +6,8 @@
 package io.openapiprocessor.core.converter
 
 import io.openapiprocessor.core.converter.mapping.Mapping
+import io.openapiprocessor.core.converter.mapping.ResultStyleOptionMapping
+import io.openapiprocessor.core.processor.mapping.v2.ResultStyle
 import io.openapiprocessor.core.support.Empty
 
 /**
@@ -68,3 +70,20 @@ class ApiOptions {
     }
 
 }
+
+/**
+ * get (global) result style option mapping value if set, otherwise [ResultStyle.SUCCESS].
+ *
+ * this is a shortcut to avoid the dependency on the
+ * [io.openapiprocessor.core.converter.mapping.MappingFinder] for this *simple* case.
+ */
+val ApiOptions.resultStyle: ResultStyle
+    get() {
+        val matches = typeMappings
+            .filterIsInstance(ResultStyleOptionMapping::class.java)
+
+        if (matches.isEmpty())
+            return ResultStyle.SUCCESS
+
+        return matches.first().value
+    }

src/main/kotlin/io/openapiprocessor/core/converter/mapping/MappingFinder.kt

@@ -8,6 +8,7 @@ package io.openapiprocessor.core.converter.mapping
 import io.openapiprocessor.core.converter.SchemaInfo
 import io.openapiprocessor.core.converter.mapping.matcher.*
 import io.openapiprocessor.core.model.HttpMethod
+import io.openapiprocessor.core.processor.mapping.v2.ResultStyle
 
 /**
  * find mappings of a given schema info in the type mapping list.
@@ -127,6 +128,21 @@ class MappingFinder(private val typeMappings: List<Mapping> = emptyList()) {
         return matches.first() as ResultTypeMapping
     }
 
+    /**
+     * get (global) result style option mapping value.
+     *
+     * @return the [ResultStyle] if set, otherwise null.
+     */
+    fun findResultStyleMapping(): ResultStyle? {
+        val matches = typeMappings
+            .filterIsInstance(ResultStyleOptionMapping::class.java)
+
+        if (matches.isEmpty())
+            return null
+
+        return matches.first().value
+    }
+
     /**
      * find (endpoint) "single" type mappings.
      *

src/main/kotlin/io/openapiprocessor/core/converter/mapping/OptionMapping.kt

@@ -0,0 +1,17 @@
+/*
+ * Copyright 2021 https://github.com/openapi-processor/openapi-processor-core
+ * PDX-License-Identifier: Apache-2.0
+ */
+
+package io.openapiprocessor.core.converter.mapping
+
+/**
+ * allows to handle simple name/value options in the mappings configuration.
+ */
+open class OptionMapping<T>(val name: String, val value: T): Mapping {
+
+    override fun getChildMappings(): List<Mapping> {
+        return listOf(this)
+    }
+
+}

src/main/kotlin/io/openapiprocessor/core/converter/mapping/ResultStyleOptionMapping.kt

@@ -0,0 +1,11 @@
+/*
+ * Copyright 2021 https://github.com/openapi-processor/openapi-processor-core
+ * PDX-License-Identifier: Apache-2.0
+ */
+
+package io.openapiprocessor.core.converter.mapping
+
+import io.openapiprocessor.core.processor.mapping.v2.ResultStyle
+
+class ResultStyleOptionMapping(resultStyle: ResultStyle):
+    OptionMapping<ResultStyle>("resultStyle", resultStyle)

src/main/kotlin/io/openapiprocessor/core/model/EndpointResponse.kt

@@ -7,6 +7,7 @@ package io.openapiprocessor.core.model
 
 import io.openapiprocessor.core.model.datatypes.AnyOneOfObjectDataType
 import io.openapiprocessor.core.model.datatypes.ResultDataType
+import io.openapiprocessor.core.processor.mapping.v2.ResultStyle
 
 /**
  * The responses that can be returned by an endpoint method for one (successful) response.
@@ -29,18 +30,36 @@ class EndpointResponse(
         get() = main.contentType
 
     /**
-     * provides the response type.
+     * provides the response type based on the requested style.
      *
-     * If the endpoint has multiple responses and there is no result data type the response type
-     * is `Object`. If the response has a result data type the response type is `ResultDataType<?>`.
+     * [ResultStyle.SUCCESS]
+     * - response type is the single success response type regardless of the number of available
+     * error responses.
+     *
+     * [ResultStyle.ALL]
+     * - If the endpoint has multiple responses the response type is `Object`. If the response is
+     * wrapped by a result data type (i.e. wrapper) the response type is `ResultDataType<?>`.
+     * - If the endpoint has only a success response type it is used as the response type.
+     *
+     * @param style required style
+     * @return the response data type in the requested style
+     */
+    fun getResponseType(style: ResultStyle): String {
+        if (isAnyOneOfResponse())
+            return getMultiResponseTypeName()
+
+        if (style == ResultStyle.ALL && errors.isNotEmpty())
+            return getMultiResponseTypeName()
+
+        return getSingleResponseTypeName()
+    }
+
+    /**
+     * test only: provides the response type.
      */
     val responseType: String
         get() {
-            return if (hasMultipleResponses()) {
-                getMultiResponseTypeName()
-            } else {
-                getSingleResponseTypeName()
-            }
+            return getResponseType(ResultStyle.SUCCESS)
         }
 
     val description: String?
@@ -49,16 +68,19 @@ class EndpointResponse(
     /**
      * provides the imports required for {@link #getResponseType()}.
      *
+     * @param style required style
      * @return list of imports
      */
-    val responseImports: Set<String>
-        get() {
-            return if (hasMultipleResponses()) {
-                getImportsMulti()
-            } else {
-                getImportsSingle()
-            }
-        }
+
+    fun getResponseImports(style: ResultStyle): Set<String> {
+        if (isAnyOneOfResponse())
+            return getImportsMulti()
+
+        if (style == ResultStyle.ALL && errors.isNotEmpty())
+            return getImportsMulti()
+
+        return getImportsSingle()
+    }
 
     /**
      * returns a list with all content types.
@@ -76,14 +98,8 @@ class EndpointResponse(
             return result
         }
 
-    /**
-     * if this response has multiple types.
-     */
-    private fun hasMultipleResponses(): Boolean {
-        if (main.responseType is AnyOneOfObjectDataType) {
-            return true
-        }
-        return errors.isNotEmpty()
+    private fun isAnyOneOfResponse(): Boolean {
+        return main.responseType is AnyOneOfObjectDataType
     }
 
     /**
@@ -109,14 +125,7 @@ class EndpointResponse(
     }
 
     private fun getImportsSingle(): Set<String> {
-        val imports = mutableSetOf<String>()
-
-        imports.addAll (main.imports)
-        errors.forEach {
-            imports.addAll (it.imports)
-        }
-
-        return imports
+        return main.imports
     }
 
 }

src/main/kotlin/io/openapiprocessor/core/processor/MappingConverter.kt

@@ -1,17 +1,6 @@
 /*
- * Copyright 2019-2020 the original authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * Copyright 2019 https://github.com/openapi-processor/openapi-processor-core
+ * PDX-License-Identifier: Apache-2.0
  */
 
 package io.openapiprocessor.core.processor
@@ -26,8 +15,6 @@ import io.openapiprocessor.core.processor.mapping.v2.Mapping as MappingV2
 /**
  *  Converter for the type mapping from the mapping yaml. It converts the type mapping information
  *  into the format used by [io.openapiprocessor.core.converter.DataTypeConverter].
- *
- *  @author Martin Hauner
  */
 class MappingConverter {
 

src/main/kotlin/io/openapiprocessor/core/processor/MappingReader.kt

@@ -6,6 +6,7 @@
 package io.openapiprocessor.core.processor
 
 import com.fasterxml.jackson.databind.DeserializationFeature
+import com.fasterxml.jackson.databind.MapperFeature
 import com.fasterxml.jackson.databind.ObjectMapper
 import com.fasterxml.jackson.databind.PropertyNamingStrategies
 import com.fasterxml.jackson.databind.module.SimpleModule
@@ -84,10 +85,11 @@ class MappingReader(private val validator: MappingValidator = MappingValidator()
             .nullIsSameAsDefault (true)
             .build ()
 
-        return ObjectMapper (YAMLFactory ())
-            .configure (DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false)
-            .setPropertyNamingStrategy (PropertyNamingStrategies.KEBAB_CASE)
-            .registerModules (kotlinModule, module)
+        return ObjectMapper(YAMLFactory())
+            .configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false)
+            .configure(MapperFeature.ACCEPT_CASE_INSENSITIVE_ENUMS, true)
+            .setPropertyNamingStrategy(PropertyNamingStrategies.KEBAB_CASE)
+            .registerModules(kotlinModule, module)
     }
 
     private fun createV1Parser(): ObjectMapper {

src/main/kotlin/io/openapiprocessor/core/processor/mapping/v2/Map.kt

@@ -1,25 +1,12 @@
 /*
- * Copyright 2020 the original authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * Copyright 2020 https://github.com/openapi-processor/openapi-processor-core
+ * PDX-License-Identifier: Apache-2.0
  */
 
 package io.openapiprocessor.core.processor.mapping.v2
 
 /**
  * the "map:" entry in the mapping yaml
- *
- *  @author Martin Hauner
  */
 data class Map(
 
@@ -28,6 +15,11 @@ data class Map(
      */
     val result: String? = null,
 
+    /**
+     * controller method return type, eg. **success** response or **all** responses
+     */
+    val resultStyle: ResultStyle? = null,
+
     /**
      * single mapping, e.g. Mono<>
      */
@@ -38,6 +30,11 @@ data class Map(
      */
     val multi: String? = null,
 
+    /**
+     * controller method response
+     */
+    val responseType: ResponseType? = ResponseType.ALL,
+
     /**
      * null wrapper, e.g. JsonNullable<>
      */

src/main/kotlin/io/openapiprocessor/core/processor/mapping/v2/MappingConverter.kt

@@ -1,17 +1,6 @@
 /*
- * Copyright 2020 the original authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * Copyright 2020 https://github.com/openapi-processor/openapi-processor-core
+ * PDX-License-Identifier: Apache-2.0
  */
 
 package io.openapiprocessor.core.processor.mapping.v2
@@ -30,8 +19,6 @@ import org.antlr.v4.runtime.tree.ParseTreeWalker
 /**
  *  Converter for the type mapping from the mapping yaml. It converts the type mapping information
  *  into the format used by [io.openapiprocessor.core.converter.DataTypeConverter].
- *
- *  @author Martin Hauner
  */
 class MappingConverter(val mapping: MappingV2) {
     companion object {
@@ -47,6 +34,10 @@ class MappingConverter(val mapping: MappingV2) {
             result.add(convertResult(mapping.map.result))
         }
 
+        if(mapping.map.resultStyle != null) {
+            result.add(convertResultStyleOption(mapping.map.resultStyle))
+        }
+
         if(mapping.map.single != null) {
             result.add(convertType("single" , mapping.map.single))
         }
@@ -79,6 +70,10 @@ class MappingConverter(val mapping: MappingV2) {
         return result
     }
 
+    private fun convertResultStyleOption(value: ResultStyle): Mapping {
+        return ResultStyleOptionMapping(value)
+    }
+
     private fun convertResult (result: String): Mapping {
         return ResultTypeMapping(result)
     }

src/main/kotlin/io/openapiprocessor/core/processor/mapping/v2/ResponseType.kt

@@ -0,0 +1,11 @@
+/*
+ * Copyright 2021 https://github.com/openapi-processor/openapi-processor-core
+ * PDX-License-Identifier: Apache-2.0
+ */
+
+package io.openapiprocessor.core.processor.mapping.v2
+
+enum class ResponseType(val kind: String) {
+    ALL("all"),
+    SUCCESS("success")
+}