extract object schema comment

Author: hauner

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/converter/DataTypeConverter.kt

@@ -9,6 +9,7 @@ import io.openapiprocessor.core.converter.mapping.*
 import io.openapiprocessor.core.converter.wrapper.NullDataTypeWrapper
 import io.openapiprocessor.core.model.DataTypeCollector
 import io.openapiprocessor.core.model.DataTypes
+import io.openapiprocessor.core.model.Documentation
 import io.openapiprocessor.core.model.datatypes.*
 import java.util.*
 import kotlin.collections.LinkedHashMap
@@ -202,7 +203,10 @@ class DataTypeConverter(
             listOf(options.packageName, "model").joinToString("."),
             properties = properties,
             constraints = constraints,
-            deprecated = schemaInfo.getDeprecated()
+            deprecated = schemaInfo.getDeprecated(),
+            documentation = Documentation(
+                description = schemaInfo.description
+            )
         )
 
         dataTypes.add (objectType)

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/converter/SchemaInfo.kt

@@ -109,6 +109,13 @@ class SchemaInfo(
         return schema?.getDefault()
     }
 
+    /**
+     * get description.
+     *
+     * @return description or null
+     */
+    val description: String? = schema?.description
+
     /**
      * get deprecated value
      *

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/model/datatypes/ObjectDataType.kt

@@ -16,6 +16,8 @@
 
 package io.openapiprocessor.core.model.datatypes
 
+import io.openapiprocessor.core.model.Documentation
+
 /**
  * OpenAPI named #/component/schemas type or an inline type.
  *
@@ -28,9 +30,10 @@ class ObjectDataType(
     private val pkg: String,
     private val properties: LinkedHashMap<String, DataType> = linkedMapOf(), // preserves order
     constraints: DataTypeConstraints? = null,
-    deprecated: Boolean = false
+    deprecated: Boolean = false,
+    override val documentation: Documentation? = null
 
-): DataTypeBase(constraints, deprecated), ModelDataType {
+): DataTypeBase(constraints, deprecated, documentation), ModelDataType {
 
     override fun getName(): String {
         return type

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/parser/Schema.kt

@@ -34,6 +34,8 @@ interface Schema {
 
     fun getDefault(): Any?
 
+    val description: String?
+
     // default false
     fun isDeprecated(): Boolean
 

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/parser/openapi4j/Schema.kt

@@ -79,6 +79,8 @@ class Schema(val schema: O4jSchema) : ParserSchema {
 
     override fun getDefault(): Any? = schema.default
 
+    override val description: String? = schema.description
+
     override fun isDeprecated(): Boolean = schema.deprecated ?: false
 
     override fun getRequired(): List<String> = schema.requiredFields ?: emptyList()

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/parser/swagger/Schema.kt

@@ -89,6 +89,8 @@ class Schema(private val schema: SwaggerSchema<*>): ParserSchema {
 
     override fun getDefault(): Any? = schema.default
 
+    override val description: String? = schema.description
+
     override fun isDeprecated(): Boolean = schema.deprecated ?: false
 
     override fun getRequired(): List<String> = schema.required ?: emptyList()

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/writer/java/DataTypeWriter.kt

@@ -38,11 +38,8 @@ class DataTypeWriter(
             target.write("@Deprecated\n")
         }
 
-        // add description
         if (apiOptions.javadoc) {
-            target.write(
-                javadocWriter.convert(dataType)
-            )
+            target.write(javadocWriter.convert(dataType))
         }
 
         target.write("public class ${dataType.getName()} {\n\n")

openapi-processor-core/src/test/groovy/com/github/hauner/openapi/core/test/TestSchema.groovy

@@ -58,6 +58,8 @@ class TestSchema implements Schema {
     Map<String, Schema> properties
     List<?> enumValues = []
 
+    String description
+
     def getDefault() {
         defaultValue
     }

openapi-processor-core/src/testInt/resources/tests/javadoc/generated/model/Foo.java

@@ -7,9 +7,7 @@
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 
-/**
- * this is the *Foo* schema description
- */
+/** this is the *Foo* schema description */
 public class Foo {
 
     /**