Merge pull request #62 from ePages-de/empty-array-schema

GH-53 Empty array schema

Author: jmewes

build.gradle.kts

@@ -104,7 +104,7 @@ subprojects {
                 }
             }
         }
-        
+
         apply(plugin = "com.jfrog.bintray")
         configure<BintrayExtension> {
             user = project.findProperty("bintrayUser") as String? ?: System.getenv("BINTRAY_USER")

restdocs-api-spec-jsonschema/src/main/kotlin/com/epages/restdocs/apispec/jsonschema/JsonSchemaFromFieldDescriptorsGenerator.kt

@@ -229,7 +229,14 @@ class JsonSchemaFromFieldDescriptorsGenerator {
                 "null" -> NullSchema.builder()
                 "empty" -> EmptySchema.builder()
                 "object" -> ObjectSchema.builder()
-                "array" -> ArraySchema.builder()
+                "array" -> ArraySchema.builder().allItemSchema(CombinedSchema.oneOf(
+                        listOf(
+                                ObjectSchema.builder().build(),
+                                BooleanSchema.builder().build(),
+                                StringSchema.builder().build(),
+                                NumberSchema.builder().build()
+                        )
+                ).build())
                 "boolean" -> BooleanSchema.builder()
                 "number" -> NumberSchema.builder()
                 "string" -> StringSchema.builder()

restdocs-api-spec-jsonschema/src/test/kotlin/com/epages/restdocs/apispec/jsonschema/JsonSchemaFromFieldDescriptorsGeneratorTest.kt

@@ -183,6 +183,17 @@ class JsonSchemaFromFieldDescriptorsGeneratorTest {
         then(JsonPath.read<String>(schemaString, "properties.id.description")).isNotEmpty()
     }
 
+    @Test
+    fun should_generate_schema_for_unspecified_array_contents() {
+        givenFieldDescriptorUnspecifiedArrayItems()
+
+        whenSchemaGenerated()
+
+        then(schema).isInstanceOf(ObjectSchema::class.java)
+        thenSchemaIsValid()
+        thenSchemaValidatesJson("""{ some: [ { "a": "b" } ] }""")
+    }
+
     private fun thenSchemaIsValid() {
 
         val report = JsonSchemaFactory.byDefault()
@@ -213,6 +224,10 @@ class JsonSchemaFromFieldDescriptorsGeneratorTest {
         fieldDescriptors = listOf(FieldDescriptor("[][]", "some", "ARRAY"))
     }
 
+    private fun givenFieldDescriptorUnspecifiedArrayItems() {
+        fieldDescriptors = listOf(FieldDescriptor("some[]", "some", "ARRAY"))
+    }
+
     private fun givenFieldDescriptorWithInvalidType() {
         fieldDescriptors = listOf(FieldDescriptor("id", "some", "invalid-type"))
     }