accept OpenAPI parameter names (openapi-processor/openapi-processor-spring#365)

Author: hauner

openapi-processor-core/src/main/antlr/Mapping.g4

@@ -14,32 +14,36 @@ type
     : anyType
     ;
 
+// basic type mapping
 map
     : sourceType Arrow anyType
     ;
 
+// content type mapping
 content
     : contentType Arrow anyType
     ;
 
+// annotation mapping
 annotate
     : sourceType Annotate annotationType
     ;
 
+// add, drop parameter
 name
-    : sourceIdentifier
+    : sourceType
     ;
 
 anyType
-    : plainType | primitiveType | targetType
+    : plainType | primitiveType | targetType | FormatType | Primitive
     ;
 
 plainType
     : Plain
     ;
 
 primitiveType
-    : primitiveValue | primitiveValue OpenArray CloseArray
+    : Primitive | Primitive OpenArray CloseArray
     ;
 
 sourceType
@@ -91,15 +95,11 @@ genericParameterAny
     ;
 
 sourceIdentifier
-    :  Identifier | String
+    : Identifier | ApiIdentifier | String | FormatType | Primitive
     ;
 
 formatIdentifier
-    : Identifier | Format | String | primitiveValue
-    ;
-
-primitiveValue
-    : 'byte' | 'short' | 'int' | 'long' | 'float' | 'double' | 'boolean' | 'char'
+    : Identifier | ApiIdentifier | String | FormatType | Primitive
     ;
 
 
@@ -123,8 +123,12 @@ Whitespace
   : [ \t] -> skip
   ;
 
+Primitive
+    : 'byte' | 'short' | 'int' | 'long' | 'float' | 'double' | 'boolean' | 'char'
+    ;
+
 Identifier
-    : JavaLetter JavaLetterOrDigit*
+    : JavaLetter JavaLetterOrDigit* | FormatType | Primitive
     ;
 
 QualifiedTypeClass
@@ -135,10 +139,15 @@ QualifiedType
     : (Identifier | Package) ('.' Identifier)*
     ;
 
-Format
-    : FormatLetter FormatLetterOrDigit*
+// Api types with optional format
+FormatType
+    : 'string' | 'integer' | 'number'
     ;
 
+ApiIdentifier
+  : ApiLetter (ApiLetterOrDigit | [ \t])+ ApiLetterOrDigit+ | FormatType | Primitive
+  ;
+
 String
     : DoubleQuote ( ~["\\] | '\\' [\t\\"] )* DoubleQuote
     ;
@@ -168,10 +177,10 @@ fragment JavaLetterOrDigit
     : [a-zA-Z0-9$_]
     ;
 
-fragment FormatLetter
+fragment ApiLetter
     :  [a-zA-Z_-]
     ;
 
-fragment FormatLetterOrDigit
+fragment ApiLetterOrDigit
     : [a-zA-Z0-9_-]
     ;

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/processor/mapping/v2/parser/antlr/MappingExtractor.kt

@@ -150,4 +150,8 @@ class MappingExtractor: MappingBaseListener(), Mapping {
             }
         }
     }
+
+    override fun enterName(ctx: MappingParser.NameContext) {
+        sourceType = ctx.text
+    }
 }

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/processor/mapping/v2/parser/antlr/Parser.kt

@@ -19,7 +19,7 @@ fun parseMapping(mapping: String): Mapping {
         val lexer = MappingLexer(CharStreams.fromString(mapping))
         val tokens = CommonTokenStream(lexer)
         val parser = MappingParser(tokens)
-        parser.removeErrorListener(ConsoleErrorListener.INSTANCE);
+        parser.removeErrorListener(ConsoleErrorListener.INSTANCE)
         parser.addErrorListener(MappingErrorListener())
         val ctx = parser.mapping()
         val extractor = MappingExtractor()

openapi-processor-core/src/test/kotlin/io/openapiprocessor/core/converter/mapping/MappingFinderEndpointMethodSpec.kt

@@ -113,15 +113,15 @@ class MappingFinderEndpointMethodSpec: StringSpec({
             |   /foo:
             |     get:
             |       parameters:
-            |         - add: fooParam => io.openapiprocessor.Foo
+            |         - add: foo-Param => io.openapiprocessor.Foo
             |         - add: barParam => io.openapiprocessor.Foo
             """)
 
         val finder = mappingFinder(options)
         val result = finder.findAddParameterTypeMappings(query(path = "/foo", method = GET))
 
         result.shouldNotBeEmpty()
-        result[0].parameterName.shouldBe("fooParam")
+        result[0].parameterName.shouldBe("foo-Param")
         result[1].parameterName.shouldBe("barParam")
     }
 
@@ -133,15 +133,15 @@ class MappingFinderEndpointMethodSpec: StringSpec({
             |   /foo:
             |     get:
             |       parameters:
-            |         - drop: fooParam
+            |         - drop: "foo-Param"
             |         - drop: barParam
             """)
 
         val finder = mappingFinder(options)
         val result = finder.findDropParameterTypeMappings(query(path = "/foo", method = GET))
 
         result.shouldNotBeEmpty()
-        result[0].parameterName.shouldBe("fooParam")
+        result[0].parameterName.shouldBe("foo-Param")
         result[1].parameterName.shouldBe("barParam")
     }
 

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

@@ -43,12 +43,13 @@ class AntlrParserSpec: StringSpec({
         mapping.targetGenericTypes.shouldBeEmpty()
     }
 
+    // only for string, number, integer
     "map source type with format to fully qualified java target type" {
-        val source = "SourceType:format => io.oap.TargetType"
+        val source = "string:format => io.oap.TargetType"
 
         val mapping = parseMapping(source)
         mapping.kind shouldBe Mapping.Kind.MAP
-        mapping.sourceType shouldBe "SourceType"
+        mapping.sourceType shouldBe "string"
         mapping.sourceFormat shouldBe "format"
         mapping.targetType shouldBe "io.oap.TargetType"
         mapping.targetGenericTypes.shouldBeEmpty()
@@ -361,4 +362,22 @@ class AntlrParserSpec: StringSpec({
         mapping.sourceType shouldBe source
         mapping.targetType shouldBe null
     }
+
+    "map simple string with dash" {
+        val source = "name-with-dash"
+
+        val mapping = parseMapping(source)
+        mapping.kind shouldBe Mapping.Kind.TYPE
+        mapping.sourceType shouldBe source
+        mapping.targetType shouldBe null
+    }
+
+    "map simple string with space" {
+        val source = "name with space"
+
+        val mapping = parseMapping(source)
+        mapping.kind shouldBe Mapping.Kind.TYPE
+        mapping.sourceType shouldBe source
+        mapping.targetType shouldBe null
+    }
 })

openapi-processor-core/src/testInt/resources/tests/params-unnecessary/inputs/foo.yaml

@@ -6,6 +6,18 @@ get:
       required: true
       schema:
         type: string
+    - name: foo-x
+      description: query, required
+      in: query
+      required: true
+      schema:
+        type: string
+    - name: foo x
+      description: query, required
+      in: query
+      required: true
+      schema:
+        type: string
   responses:
     '204':
       description: empty

openapi-processor-core/src/testInt/resources/tests/params-unnecessary/inputs/mapping.yaml

@@ -10,3 +10,5 @@ map:
     /foo:
       parameters:
         - drop: foo
+        - drop: foo-x
+        - drop: foo x