#24, find nested schemas of additionalProperties

(cherry picked from commit 511bf30)

Author: hauner

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

@@ -242,6 +242,12 @@ class DataTypeConverter(
             properties[propName] = propDataType
         }
 
+        // navigate additionalProperties to find nested schemas
+        val additionalSchemaInfo = schemaInfo.buildForAdditionalProperties()
+        if (additionalSchemaInfo != null) {
+            convert(additionalSchemaInfo, dataTypes)
+        }
+
         val objectType = createObjectDataType(schemaInfo, properties)
 
         val targetType = getMappedDataType(schemaInfo)

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

@@ -328,6 +328,21 @@ open class SchemaInfo(
         )
     }
 
+    /**
+     * Factory method to create an {@link SchemaInfo} of additionalProperties.
+     *
+     * @return a new {@link SchemaInfo}
+     */
+    fun buildForAdditionalProperties(): SchemaInfo? {
+        val additionalProperties = schema?.getAdditionalProperties() ?: return null
+
+        return SchemaInfo(
+            endpoint = endpoint,
+            name = getNestedTypeName("additionalProperties"),
+            schema = additionalProperties,
+            resolver = resolver)
+    }
+
     override fun isPrimitive(): Boolean {
         return listOf("boolean", "integer", "number", "string").contains(schema?.getType())
     }

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

@@ -24,6 +24,7 @@ interface Schema {
 
     // object
     fun getProperties(): Map<String, Schema>
+    fun getAdditionalProperties(): Schema?
 
     // composed object
     fun getItems(): List<Schema>

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

@@ -72,6 +72,17 @@ class Schema(val schema: Schema30) : ParserSchema {
         return props
     }
 
+    override fun getAdditionalProperties(): Schema? {
+        val additional = schema.additionalProperties
+
+        // null, boolean, schema
+        if(additional is Schema30) {
+            return Schema(additional)
+        }
+
+        return null;
+    }
+
     override fun getItems(): List<ParserSchema> {
         val result: MutableList<ParserSchema> = mutableListOf()
 

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

@@ -72,6 +72,17 @@ class Schema(val schema: Schema31) : ParserSchema {
         return props
     }
 
+    override fun getAdditionalProperties(): Schema? {
+        val additional = schema.additionalProperties
+
+        // null, boolean, schema
+        if(additional is Schema31) {
+            return Schema(additional)
+        }
+
+        return null;
+    }
+
     override fun getItems(): List<ParserSchema> {
         val result: MutableList<ParserSchema> = mutableListOf()
 

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

@@ -43,6 +43,17 @@ class Schema(val schema: O4jSchema) : ParserSchema {
         return props
     }
 
+    override fun getAdditionalProperties(): Schema? {
+        val additional = schema.additionalProperties
+
+        // null, boolean, schema
+        if(additional is O4jSchema) {
+            return Schema(additional)
+        }
+
+        return null;
+    }
+
     override fun getItems(): List<ParserSchema> {
         val result: MutableList<ParserSchema> = mutableListOf()
 

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

@@ -45,6 +45,17 @@ class Schema(private val schema: SwaggerSchema<*>): ParserSchema {
         return props
     }
 
+    override fun getAdditionalProperties(): ParserSchema? {
+        val additional = schema.additionalProperties
+
+        // null, boolean, schema
+        if(additional is SwaggerSchema<*>) {
+            return Schema(additional)
+        }
+
+        return null;
+    }
+
     override fun getItems(): List<ParserSchema> {
         val result: MutableList<ParserSchema> = mutableListOf()
 

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

@@ -79,4 +79,9 @@ class TestSchema implements Schema {
     boolean getWriteOnly () {
         return false
     }
+
+    @Override
+    Schema getAdditionalProperties() {
+        return null
+    }
 }

openapi-processor-core/src/test/kotlin/io/openapiprocessor/core/parser/swagger/AdditionalPropertiesSpec.kt

@@ -0,0 +1,80 @@
+/*
+ * Copyright 2023 https://github.com/openapi-processor/openapi-processor-base
+ * PDX-License-Identifier: Apache-2.0
+ */
+
+package io.openapiprocessor.core.parser.swagger
+
+import io.kotest.core.spec.IsolationMode
+import io.kotest.core.spec.style.StringSpec
+import io.kotest.matchers.nulls.shouldBeNull
+import io.kotest.matchers.nulls.shouldNotBeNull
+import io.openapiprocessor.core.model.HttpMethod
+import io.openapiprocessor.core.parser.ParserType
+import io.openapiprocessor.core.support.getSchemaInfo
+import io.openapiprocessor.core.support.parse
+
+class AdditionalPropertiesSpec: StringSpec({
+    isolationMode = IsolationMode.InstancePerTest
+
+    "additionalProperties of empty object is empty object" {
+        val openApi = parse("""
+           openapi: 3.0.2
+           info:
+             title: API
+             version: 1.0.0
+           
+           paths:
+            /values:
+              get:
+                description: query object dictionary
+                responses:
+                  '200':
+                    description: dictionary response
+                    content:
+                      application/json:
+                        schema:
+                          type: object
+                          additionalProperties: {}
+
+        """.trimIndent(), ParserType.SWAGGER
+        )
+
+
+        val schemaInfo = openApi.getSchemaInfo("Values",
+            "/values", HttpMethod.GET, "200", "application/json")
+
+        val additional = schemaInfo.buildForAdditionalProperties()
+        additional.shouldNotBeNull()
+    }
+
+    "additionalProperties of boolean object is null" {
+        val openApi = parse("""
+           openapi: 3.0.2
+           info:
+             title: API
+             version: 1.0.0
+           
+           paths:
+            /values:
+              get:
+                description: query object dictionary
+                responses:
+                  '200':
+                    description: dictionary response
+                    content:
+                      application/json:
+                        schema:
+                          type: object
+                          additionalProperties: true
+
+        """.trimIndent(), ParserType.SWAGGER
+        )
+
+        val schemaInfo = openApi.getSchemaInfo("Values",
+            "/values", HttpMethod.GET, "200", "application/json")
+
+        val additional = schemaInfo.buildForAdditionalProperties()
+        additional.shouldBeNull()
+    }
+})