update/validate json schema of mapping.yaml

Author: hauner

openapi-processor-core/build.gradle

@@ -142,6 +142,7 @@ dependencies {
     testImplementation("io.mockk:mockk:1.10.4")
     testImplementation("io.kotest:kotest-runner-junit5:4.3.2")
     testImplementation 'ch.qos.logback:logback-classic:1.2.3'
+    testImplementation "com.networknt:json-schema-validator:1.0.49"
 }
 
 tasks.withType(Test) {

openapi-processor-core/src/main/resources/mapping/v2/mapping.example.yaml

@@ -13,6 +13,8 @@ options: # general processor options (optional)
   # validation annotation (optional): true or false (default)
   bean-validation: false
 
+  javadoc: true
+
 map: # the type mappings
 
   # global mappings, apply to all paths/endpoints
@@ -72,3 +74,7 @@ map: # the type mappings
       responses:
         - content: application/vnd.any => java.util.Set
         - content: application/json => java.util.Map
+
+    /third:
+      patch:
+        null: org.openapitools.jackson.nullable.JsonNullable = JsonNullable.undefined()

openapi-processor-core/src/main/resources/mapping/v2/mapping.yaml.json

@@ -26,6 +26,7 @@
     "Options": {
       "description": "general processor configuration options.",
       "type": "object",
+      "additionalProperties": false,
       "properties": {
         "package-name": {
           "description": "java root package name to use in the generated source files.",
@@ -36,6 +37,11 @@
           "description": "enable bean validation annotations for OpenAPI constraints.",
           "type": "boolean",
           "default": false
+        },
+        "javadoc": {
+          "description": "generate javadoc from OpenAPI 'description' properties (since core 2021.1).",
+          "type": "boolean",
+          "default": false
         }
       }
     },
@@ -63,8 +69,9 @@
               "$ref": "#/definitions/Exclude"
             }, {
               "$ref": "#/definitions/Mappings"
-            }
-          ]
+            }, {
+              "$ref": "#/definitions/Methods"
+          }]
         }
       }
     },
@@ -81,6 +88,9 @@
         "multi": {
           "$ref": "#/definitions/MultiMapping"
         },
+        "null": {
+          "$ref": "#/definitions/NullMapping"
+        },
         "types": {
           "$ref": "#/definitions/TypeMappings"
         },
@@ -92,6 +102,31 @@
         }
       }
     },
+    "Methods": {
+      "description": "http method mapping rules (since core 2021.2).",
+      "type": "object",
+      "get": {
+        "$ref": "#/definitions/Mappings"
+      },
+      "put": {
+        "$ref": "#/definitions/Mappings"
+      },
+      "post": {
+        "$ref": "#/definitions/Mappings"
+      },
+      "delete": {
+        "$ref": "#/definitions/Mappings"
+      },
+      "options": {
+        "$ref": "#/definitions/Mappings"
+      },
+      "head": {
+        "$ref": "#/definitions/Mappings"
+      },
+      "patch": {
+        "$ref": "#/definitions/Mappings"
+      }
+    },
     "ResultMapping": {
       "description": "wrapper object of a http response.",
       "type": "string",
@@ -113,6 +148,14 @@
         "reactor.core.publisher.Flux"
       ]
     },
+    "NullMapping": {
+      "description": "null wrapper of 'nullable' object properties (since core 2021.2).",
+      "type": "string",
+      "examples": [
+        "org.openapitools.jackson.nullable.JsonNullable",
+        "org.openapitools.jackson.nullable.JsonNullable = JsonNullable.undefined()"
+      ]
+    },
     "TypeMappings": {
       "description": "basic type mappings.",
       "type": "array",

openapi-processor-core/src/test/kotlin/io/openapiprocessor/core/processor/mapping/v2/ValidateSpec.kt

@@ -0,0 +1,32 @@
+package io.openapiprocessor.core.processor.mapping.v2
+
+import com.fasterxml.jackson.databind.ObjectMapper
+import com.fasterxml.jackson.dataformat.yaml.YAMLFactory
+import com.networknt.schema.JsonSchemaFactory
+import com.networknt.schema.SpecVersion
+import io.kotest.core.spec.style.StringSpec
+import java.io.InputStream
+import io.kotest.matchers.collections.shouldBeEmpty
+
+
+class ValidateSpec: StringSpec({
+
+    fun getResource(path: String): InputStream {
+        return this.javaClass.getResourceAsStream(path)
+    }
+
+    "validate" {
+        val yaml = ObjectMapper(YAMLFactory ())
+        val yamlData = getResource("/mapping/v2/mapping.example.yaml")
+        val node = yaml.readTree(yamlData)
+
+        val factory = JsonSchemaFactory.getInstance(SpecVersion.VersionFlag.V7)
+        val schemaData = getResource("/mapping/v2/mapping.yaml.json")
+        val schema = factory.getSchema(schemaData)
+
+        val errors = schema.validate(node)
+
+        errors.shouldBeEmpty()
+    }
+
+})