create object schema & properties javadoc

Author: hauner

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

@@ -204,9 +204,7 @@ class DataTypeConverter(
             properties = properties,
             constraints = constraints,
             deprecated = schemaInfo.getDeprecated(),
-            documentation = Documentation(
-                description = schemaInfo.description
-            )
+            documentation = Documentation(description = schemaInfo.description)
         )
 
         dataTypes.add (objectType)
@@ -246,22 +244,29 @@ class DataTypeConverter(
         return when(typeFormat) {
             "integer",
             "integer:int32" ->
-                IntegerDataType(constraints, schemaInfo.getDeprecated())
+                IntegerDataType(constraints, schemaInfo.getDeprecated(),
+                    Documentation(description = schemaInfo.description))
             "integer:int64" ->
-                LongDataType(constraints, schemaInfo.getDeprecated())
+                LongDataType(constraints, schemaInfo.getDeprecated(),
+                    Documentation(description = schemaInfo.description))
             "number",
             "number:float" ->
-                FloatDataType(constraints, schemaInfo.getDeprecated())
+                FloatDataType(constraints, schemaInfo.getDeprecated(),
+                    Documentation(description = schemaInfo.description))
             "number:double" ->
-                DoubleDataType(constraints, schemaInfo.getDeprecated())
+                DoubleDataType(constraints, schemaInfo.getDeprecated(),
+                    Documentation(description = schemaInfo.description))
             "boolean" ->
-                BooleanDataType(constraints, schemaInfo.getDeprecated())
+                BooleanDataType(constraints, schemaInfo.getDeprecated(),
+                    Documentation(description = schemaInfo.description))
             "string" ->
                 createStringDataType(schemaInfo, constraints, dataTypes)
             "string:date" ->
-                LocalDateDataType(constraints, schemaInfo.getDeprecated())
+                LocalDateDataType(constraints, schemaInfo.getDeprecated(),
+                    Documentation(description = schemaInfo.description))
             "string:date-time" ->
-                OffsetDateTimeDataType (constraints, schemaInfo.getDeprecated())
+                OffsetDateTimeDataType (constraints, schemaInfo.getDeprecated(),
+                    Documentation(description = schemaInfo.description))
             else ->
                 throw UnknownDataTypeException(schemaInfo.getName(), schemaInfo.getType(),
                     schemaInfo.getFormat())
@@ -294,9 +299,12 @@ class DataTypeConverter(
             "date-time")
     }
 
-    private fun createStringDataType(schemaInfo: SchemaInfo, constraints: DataTypeConstraints, dataTypes: DataTypes): DataType {
+    private fun createStringDataType(schemaInfo: SchemaInfo, constraints: DataTypeConstraints,
+        dataTypes: DataTypes): DataType {
+
         if (!schemaInfo.isEnum()) {
-            return StringDataType(constraints, schemaInfo.getDeprecated())
+            return StringDataType(constraints, schemaInfo.getDeprecated(),
+                Documentation(description = schemaInfo.description))
         }
 
         // in case of an inline definition the name may be lowercase, make sure the enum

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

@@ -16,6 +16,8 @@
 
 package io.openapiprocessor.core.model.datatypes
 
+import io.openapiprocessor.core.model.Documentation
+
 /**
  * OpenAPI type 'boolean' maps to java Boolean.
  *
@@ -24,9 +26,10 @@ package io.openapiprocessor.core.model.datatypes
 class BooleanDataType(
 
    constraints: DataTypeConstraints? = null,
-   deprecated: Boolean = false
+   deprecated: Boolean = false,
+   documentation: Documentation? = null
 
-): DataTypeBase(constraints, deprecated) {
+): DataTypeBase(constraints, deprecated, documentation) {
 
     override fun getName(): String {
         return "Boolean"

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

@@ -16,6 +16,8 @@
 
 package io.openapiprocessor.core.model.datatypes
 
+import io.openapiprocessor.core.model.Documentation
+
 /**
  * OpenAPI type 'number' with format 'double' maps to java Double.
  *
@@ -24,9 +26,10 @@ package io.openapiprocessor.core.model.datatypes
 class DoubleDataType(
 
     constraints: DataTypeConstraints? = null,
-    deprecated: Boolean = false
+    deprecated: Boolean = false,
+    documentation: Documentation? = null
 
-): DataTypeBase(constraints, deprecated) {
+): DataTypeBase(constraints, deprecated, documentation) {
 
     override fun getName(): String {
         return "Double"

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

@@ -16,6 +16,8 @@
 
 package io.openapiprocessor.core.model.datatypes
 
+import io.openapiprocessor.core.model.Documentation
+
 /**
  * OpenAPI type 'number' with format 'float' maps to java Float.
  *
@@ -24,9 +26,10 @@ package io.openapiprocessor.core.model.datatypes
 class FloatDataType(
 
     constraints: DataTypeConstraints? = null,
-    deprecated: Boolean = false
+    deprecated: Boolean = false,
+    documentation: Documentation? = null
 
-): DataTypeBase(constraints, deprecated) {
+): DataTypeBase(constraints, deprecated, documentation) {
 
     override fun getName(): String {
         return "Float"

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

@@ -16,6 +16,8 @@
 
 package io.openapiprocessor.core.model.datatypes
 
+import io.openapiprocessor.core.model.Documentation
+
 /**
  * OpenAPI type 'integer' with format 'int32' maps to java Integer.
  *
@@ -24,9 +26,10 @@ package io.openapiprocessor.core.model.datatypes
 class IntegerDataType(
 
     constraints: DataTypeConstraints? = null,
-    deprecated: Boolean = false
+    deprecated: Boolean = false,
+    documentation: Documentation? = null
 
-): DataTypeBase(constraints, deprecated) {
+): DataTypeBase(constraints, deprecated, documentation) {
 
     override fun getName(): String {
         return "Integer"

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

@@ -16,6 +16,8 @@
 
 package io.openapiprocessor.core.model.datatypes
 
+import io.openapiprocessor.core.model.Documentation
+
 /**
  * OpenAPI type 'string' with format 'date' maps to java LocalDate.
  *
@@ -24,9 +26,10 @@ package io.openapiprocessor.core.model.datatypes
 class LocalDateDataType(
 
     constraints: DataTypeConstraints? = null,
-    deprecated: Boolean = false
+    deprecated: Boolean = false,
+    documentation: Documentation? = null
 
-): DataTypeBase(constraints, deprecated) {
+): DataTypeBase(constraints, deprecated, documentation) {
 
     override fun getName(): String {
         return "LocalDate"
@@ -35,5 +38,5 @@ class LocalDateDataType(
     override fun getPackageName(): String {
         return "java.time"
     }
-    
+
 }

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

@@ -16,6 +16,8 @@
 
 package io.openapiprocessor.core.model.datatypes
 
+import io.openapiprocessor.core.model.Documentation
+
 /**
  * OpenAPI type 'integer' with format 'int64' maps to java Long.
  *
@@ -24,9 +26,10 @@ package io.openapiprocessor.core.model.datatypes
 class LongDataType(
 
     constraints: DataTypeConstraints? = null,
-    deprecated: Boolean = false
+    deprecated: Boolean = false,
+    documentation: Documentation? = null
 
-): DataTypeBase(constraints, deprecated) {
+): DataTypeBase(constraints, deprecated, documentation) {
 
     override fun getName(): String {
         return "Long"

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

@@ -16,6 +16,8 @@
 
 package io.openapiprocessor.core.model.datatypes
 
+import io.openapiprocessor.core.model.Documentation
+
 /**
  * OpenAPI type 'string' with format 'date-time' maps to java OffsetDateTime.
  *
@@ -24,7 +26,8 @@ package io.openapiprocessor.core.model.datatypes
 class OffsetDateTimeDataType(
 
     constraints: DataTypeConstraints? = null,
-    deprecated: Boolean = false
+    deprecated: Boolean = false,
+    documentation: Documentation? = null
 
 ): DataTypeBase(constraints, deprecated) {
 

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

@@ -16,6 +16,8 @@
 
 package io.openapiprocessor.core.model.datatypes
 
+import io.openapiprocessor.core.model.Documentation
+
 /**
  * OpenAPI type 'string' maps to java String.
  *
@@ -24,9 +26,10 @@ package io.openapiprocessor.core.model.datatypes
 class StringDataType(
 
     constraints: DataTypeConstraints? = null,
-    deprecated: Boolean = false
+    deprecated: Boolean = false,
+    documentation: Documentation? = null
 
-): DataTypeBase(constraints, deprecated) {
+): DataTypeBase(constraints, deprecated, documentation) {
 
     override fun getName(): String {
         return "String"

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

@@ -65,6 +65,11 @@ class DataTypeWriter(
         propDataType: DataType, required: Boolean): String {
 
         var result = ""
+
+        if (apiOptions.javadoc) {
+            result += javadocWriter.convert(propDataType)
+        }
+
         if (propDataType.isDeprecated()) {
             result += "    @Deprecated\n"
         }