Merge pull request #83 from openapi-processor/read-write-only

Read write only

Author: hauner

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

@@ -155,13 +155,20 @@ class DataTypeConverter(
     }
 
     private fun createObjectDataType(schemaInfo: SchemaInfo, dataTypes: DataTypes): DataType {
-        val properties = LinkedHashMap<String, DataType>()
+        val properties = LinkedHashMap<String, PropertyDataType>()
         schemaInfo.eachProperty { propName: String, propSchemaInfo: SchemaInfo ->
             var propDataType = convert(propSchemaInfo, dataTypes)
 
             if (propSchemaInfo.getNullable()) {
                 propDataType = nullWrapper.wrap(propDataType, schemaInfo)
             }
+
+            propDataType = PropertyDataType(
+                propSchemaInfo.readOnly,
+                propSchemaInfo.writeOnly,
+                propDataType
+            )
+
             properties[propName] = propDataType
         }
 

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

@@ -53,7 +53,7 @@ class SchemaInfo(
      * schema.
      *
      * The swagger parser (resolve option) creates schemas for intermediate $refs where the name is
-     * based on the filename. This breaks code generation because the original/public name of the
+     * based on the filename. It breaks code generation because the original/public name of the
      * schema is lost.
      */
     private var refName: Boolean = false
@@ -219,6 +219,12 @@ class SchemaInfo(
     val pattern: String?
         get() = schema?.pattern
 
+    val readOnly: Boolean
+        get() = schema?.readOnly ?: false
+
+    val writeOnly: Boolean
+        get() = schema?.writeOnly ?: false
+
     /**
      * iterate over properties
      */

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

@@ -53,6 +53,9 @@ class DataTypeCollector(
             is StringEnumDataType -> {
                 dataTypes.addRef(dataType.getName())
             }
+            is PropertyDataType -> {
+                collect(dataType.dataType)
+            }
         }
     }
 

src/main/kotlin/io/openapiprocessor/core/model/datatypes/DataType.kt

@@ -31,7 +31,7 @@ interface DataType {
     }
 
     /**
-     * The "package" of this type without [typeName].
+     * The "package" of this type without [getTypeName].
      */
     fun getPackageName(): String
 

src/main/kotlin/io/openapiprocessor/core/model/datatypes/NullDataType.kt

@@ -6,7 +6,8 @@
 package io.openapiprocessor.core.model.datatypes
 
 /**
- * Null(able) data type wrapper. Assumes a single generic parameter.
+ * Null(able) data type wrapper, i.e. [org.openapitools.jackson.nullable.JsonNullable]. Assumes a
+ * single generic parameter.
  */
 class NullDataType(
     private val name: String,

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

@@ -14,7 +14,7 @@ open class ObjectDataType(
     private val name: DataTypeName,
     private val pkg: String,
     /** linked map to preserve order */
-    private val properties: LinkedHashMap<String, DataType> = linkedMapOf(),
+    private val properties: LinkedHashMap<String, PropertyDataType> = linkedMapOf(),
     override val constraints: DataTypeConstraints? = null,
     override val deprecated: Boolean = false,
     override val documentation: Documentation? = null
@@ -44,15 +44,15 @@ open class ObjectDataType(
                 .toSet()
         }
 
-    fun addObjectProperty(name: String, type: DataType) {
+    fun addObjectProperty(name: String, type: PropertyDataType) {
         properties[name] = type
     }
 
-    fun getObjectProperty(name: String): DataType {
+    fun getObjectProperty(name: String): PropertyDataType {
         return properties[name]!!
     }
 
-    fun getProperties(): Map<String, DataType> {
+    fun getProperties(): Map<String, PropertyDataType> {
         return properties
     }
 

src/main/kotlin/io/openapiprocessor/core/model/datatypes/PropertyDataType.kt

@@ -0,0 +1,49 @@
+/*
+ * Copyright 2021 https://github.com/openapi-processor/openapi-processor-core
+ * PDX-License-Identifier: Apache-2.0
+ */
+
+package io.openapiprocessor.core.model.datatypes
+
+import io.openapiprocessor.core.model.Documentation
+
+/**
+ * schema "properties" data type wrapper. readOnly/writeOnly may be different on each use of the
+ * same schema as a property in another schema.
+ */
+open class PropertyDataType(
+    val readOnly: Boolean,
+    val writeOnly: Boolean,
+    val dataType: DataType
+): DataType {
+
+    override fun getName(): String {
+        return dataType.getName()
+    }
+
+    override fun getTypeName(): String {
+        return dataType.getTypeName()
+    }
+
+    override fun getPackageName(): String {
+        return dataType.getPackageName()
+    }
+
+    override fun getImports(): Set<String> {
+        return dataType.getImports()
+    }
+
+    override val referencedImports: Set<String>
+        get() = dataType.referencedImports
+
+    override val constraints: DataTypeConstraints?
+        get() = dataType.constraints
+
+    override val deprecated: Boolean
+        get() = dataType.deprecated
+
+    override val documentation: Documentation?
+        get() = dataType.documentation
+
+}
+

src/main/kotlin/io/openapiprocessor/core/parser/Schema.kt

@@ -58,4 +58,6 @@ interface Schema {
 
     val pattern: String?
 
+    val readOnly: Boolean
+    val writeOnly: Boolean
 }

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

@@ -106,4 +106,10 @@ class Schema(val schema: O4jSchema) : ParserSchema {
     override val pattern: String?
         get() = schema.pattern
 
+    override val readOnly: Boolean
+        get() = schema.readOnly ?: false
+
+    override val writeOnly: Boolean
+        get() = schema.writeOnly ?: false
+
 }

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

@@ -116,5 +116,10 @@ class Schema(private val schema: SwaggerSchema<*>): ParserSchema {
     override val pattern: String?
         get() = schema.pattern
 
+    override val readOnly: Boolean
+        get() = schema.readOnly ?: false
+
+    override val writeOnly: Boolean
+        get() = schema.writeOnly ?: false
 
 }