Merge pull request #9 from openapi-processor/mapping-format-identifier

resolves #2
openapi-processor · Jun 19, 2020 · 3c8407b · 3c8407b
2 parents b4cb5ab + b4958b8
commit 3c8407b
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 14 deletions.
diff --git a/...essor-core/src/main/kotlin/com/github/hauner/openapi/core/processor/mapping/v2/Mapping.kt b/...essor-core/src/main/kotlin/com/github/hauner/openapi/core/processor/mapping/v2/Mapping.kt
@@ -16,6 +16,7 @@
 
 package com.github.hauner.openapi.core.processor.mapping.v2
 
+import com.fasterxml.jackson.annotation.JsonAlias
 import com.fasterxml.jackson.annotation.JsonProperty
 import com.github.hauner.openapi.core.processor.mapping.VersionedMapping
 
@@ -29,7 +30,9 @@ data class Mapping(
         /**
      * mapping format version
      */
-    @JsonProperty("openapi-processor-spring") val version: String,
+    @JsonProperty("openapi-processor-mapping")
+    @JsonAlias("openapi-processor-spring") // deprecated
+    val version: String,
 
         /**
      * general options

diff --git a/...-core/src/main/kotlin/com/github/hauner/openapi/core/processor/mapping/version/Mapping.kt b/...-core/src/main/kotlin/com/github/hauner/openapi/core/processor/mapping/version/Mapping.kt
@@ -16,9 +16,13 @@
 
 package com.github.hauner.openapi.core.processor.mapping.version
 
+import com.fasterxml.jackson.annotation.JsonAlias
 import com.fasterxml.jackson.annotation.JsonProperty
 
-data class Mapping(@JsonProperty("openapi-processor-spring") val version: String?) {
+data class Mapping(
+        @JsonProperty("openapi-processor-mapping")
+        @JsonAlias("openapi-processor-spring") // deprecated
+        val version: String?) {
 
     fun isV2(): Boolean {
         if (version == null) {

diff --git a/...re/src/test/groovy/com/github/hauner/openapi/core/processor/MappingConverterV2Spec.groovy b/...re/src/test/groovy/com/github/hauner/openapi/core/processor/MappingConverterV2Spec.groovy
@@ -36,7 +36,7 @@ class MappingConverterV2Spec extends Specification {
     @Unroll
     void "reads global type mapping: (#input.source)" () {
         String yaml = """\
-openapi-processor-spring: v2.0
+openapi-processor-mapping: v2.0
 
 map:
   types:
@@ -141,7 +141,7 @@ map:
 
     void "reads global response type mapping" () {
         String yaml = """\
-openapi-processor-spring: v2.0
+openapi-processor-mapping: v2.0
 
 map:
   responses:
@@ -165,7 +165,7 @@ map:
 
     void "reads global parameter type mapping" () {
         String yaml = """\
-openapi-processor-spring: v2.0
+openapi-processor-mapping: v2.0
     
 map:
   parameters:
@@ -197,7 +197,7 @@ map:
 
     void "reads endpoint exclude flag" () {
         String yaml = """\
-openapi-processor-spring: v2.0
+openapi-processor-mapping: v2.0
     
 map:
   paths:
@@ -223,7 +223,7 @@ map:
 
     void "reads endpoint parameter type mapping" () {
         String yaml = """\
-openapi-processor-spring: v2.0
+openapi-processor-mapping: v2.0
     
 map:
   paths:
@@ -252,7 +252,7 @@ map:
 
     void "reads endpoint add mapping" () {
         String yaml = """\
-openapi-processor-spring: v2.0
+openapi-processor-mapping: v2.0
     
 map:
   paths:
@@ -282,7 +282,7 @@ map:
 
     void "reads endpoint response type mapping" () {
         String yaml = """\
-openapi-processor-spring: v2.0
+openapi-processor-mapping: v2.0
     
 map:
   paths:
@@ -312,7 +312,7 @@ map:
 
     void "reads global result mapping #result" () {
         String yaml = """\
-openapi-processor-spring: v2.0
+openapi-processor-mapping: v2.0
     
 map:
   result: $result
@@ -335,7 +335,7 @@ map:
 
     void "reads endpoint result mapping #result" () {
         String yaml = """\
-openapi-processor-spring: v2.0
+openapi-processor-mapping: v2.0
     
 map:
   paths:
@@ -365,7 +365,7 @@ map:
 
     void "reads global single & multi mapping" () {
         String yaml = """\
-openapi-processor-spring: v2.0
+openapi-processor-mapping: v2.0
     
 map:
   single: $single
@@ -392,7 +392,7 @@ map:
 
     void "reads endpoint single & multi mapping" () {
         String yaml = """\
-openapi-processor-spring: v2.0
+openapi-processor-mapping: v2.0
     
 map:
   paths:

diff --git a/...core/src/test/groovy/com/github/hauner/openapi/core/processor/MappingExampleV2Spec.groovy b/...core/src/test/groovy/com/github/hauner/openapi/core/processor/MappingExampleV2Spec.groovy
@@ -29,7 +29,7 @@ class MappingExampleV2Spec extends Specification {
 
 
     String yaml = """
-openapi-processor-spring: v2
+openapi-processor-mapping: v2
 
 options:
     package-name: com.github.hauner.openapi