new parameter required by core 2021.1

Author: hauner

src/main/kotlin/io/openapiprocessor/spring/model/parameters/QueryParameter.kt

@@ -27,8 +27,13 @@ import io.openapiprocessor.core.model.datatypes.ObjectDataType
  *
  * @author Martin Hauner
  */
-class QueryParameter(name: String, dataType: DataType, required: Boolean, deprecated: Boolean)
-    : ParameterBase(name, dataType, required, deprecated) {
+class QueryParameter(
+    name: String,
+    dataType: DataType,
+    required: Boolean = false,
+    deprecated: Boolean = false,
+    description: String? = null
+): ParameterBase(name, dataType, required, deprecated, description) {
 
     /**
      * controls if a parameter should have a {@code @RequestParam} annotation.

src/test/groovy/com/github/hauner/openapi/spring/writer/java/CookieParameterAnnotationWriterSpec.groovy

@@ -28,7 +28,8 @@ class CookieParameterAnnotationWriterSpec extends Specification {
     def target = new StringWriter()
 
     void "write simple (required) cookie parameter" () {
-        def param = new CookieParameter('foo', new StringDataType(), true, false)
+        def param = new CookieParameter(
+            'foo', new StringDataType(), true, false, null)
 
         when:
         writer.write (target, param)
@@ -38,7 +39,8 @@ class CookieParameterAnnotationWriterSpec extends Specification {
     }
 
     void "write simple (optional) cookie parameter" () {
-        def param = new CookieParameter('foo', new StringDataType(), false, false)
+        def param = new CookieParameter(
+            'foo', new StringDataType(), false, false, null)
 
         when:
         writer.write (target, param)
@@ -50,7 +52,7 @@ class CookieParameterAnnotationWriterSpec extends Specification {
     void "write simple (optional with default) cookie parameter" () {
         def param = new CookieParameter('foo',
             new StringDataType(createConstraints ('bar'), false),
-            false, false)
+            false, false, null)
 
         when:
         writer.write (target, param)

src/test/groovy/com/github/hauner/openapi/spring/writer/java/HeaderParameterAnnotationWriterSpec.groovy

@@ -28,7 +28,8 @@ class HeaderParameterAnnotationWriterSpec extends Specification {
     def target = new StringWriter()
 
     void "write simple (required) header parameter" () {
-        def param = new HeaderParameter('foo', new StringDataType(), true, false)
+        def param = new HeaderParameter(
+            'foo', new StringDataType(), true, false, null)
 
         when:
         writer.write (target, param)
@@ -38,7 +39,8 @@ class HeaderParameterAnnotationWriterSpec extends Specification {
     }
 
     void "write simple (optional) header parameter" () {
-        def param = new HeaderParameter('foo', new StringDataType(), false, false)
+        def param = new HeaderParameter(
+            'foo', new StringDataType(), false, false, null)
 
         when:
         writer.write (target, param)
@@ -50,7 +52,7 @@ class HeaderParameterAnnotationWriterSpec extends Specification {
     void "write simple (optional with default) header parameter" () {
         def param = new HeaderParameter('foo',
             new StringDataType(createConstraints ('bar'), false),
-            false, false)
+            false, false, null)
 
         when:
         writer.write (target, param)

src/test/groovy/com/github/hauner/openapi/spring/writer/java/MappingAnnotationWriterSpec.groovy

@@ -74,7 +74,7 @@ class MappingAnnotationWriterSpec extends Specification {
 
     void "writes 'produces' parameter with response content type" () {
         def endpoint = createEndpoint (path: '/foo', method: HttpMethod.GET, responses: [
-            '200' : [new Response (contentType, new StringDataType ())]
+            '200' : [new Response (contentType, new StringDataType (), null)]
         ])
 
         when:
@@ -92,7 +92,7 @@ class MappingAnnotationWriterSpec extends Specification {
     void "writes 'consumes' & 'produces' parameters" () {
         def endpoint = createEndpoint (path: '/foo', method: HttpMethod.GET, responses: [
             '200' : [
-                new Response (responseContentType, new StringDataType ())
+                new Response (responseContentType, new StringDataType (), null)
             ]
         ], requestBodies: [
             new RequestBody('body', requestContentType, new StringDataType (),
@@ -113,10 +113,10 @@ class MappingAnnotationWriterSpec extends Specification {
     void "writes mapping annotation with multiple result content types" () {
         def endpoint = createEndpoint (path: '/foo', method: HttpMethod.GET, responses: [
             '200' : [
-                new Response ('application/json', new StringDataType ())
+                new Response ('application/json', new StringDataType (), null)
             ],
             'default': [
-                new Response ('text/plain', new StringDataType ())
+                new Response ('text/plain', new StringDataType (), null)
             ]
         ])
 
@@ -133,7 +133,8 @@ class MappingAnnotationWriterSpec extends Specification {
             properties.path as String ?: '',
             properties.method as HttpMethod ?: HttpMethod.GET,
             properties.operationId as String ?: null,
-            properties.deprecated as boolean ?: false
+            properties.deprecated as boolean ?: false,
+            properties.description as String ?: null
         )
         ep.parameters = properties.parameters ?: []
         ep.responses = properties.responses ?: [:]

src/test/groovy/com/github/hauner/openapi/spring/writer/java/ParameterAnnotationWriterSpec.groovy

@@ -38,7 +38,7 @@ class ParameterAnnotationWriterSpec extends Specification {
     void "writes simple (optional) query parameter with quoted string default value" () {
         def param = clazz.newInstance('foo',
             new StringDataType(createConstraints ('bar'), false),
-            false, false)
+            false, false, null)
 
         when:
         writer.write (target, param)
@@ -57,7 +57,7 @@ class ParameterAnnotationWriterSpec extends Specification {
     void "writes simple (optional) query parameter with quoted number default value" () {
         def param = clazz.newInstance ('foo',
             new LongDataType (createConstraints (5), false),
-            false, false)
+            false, false, null)
 
         when:
         writer.write (target, param)

src/test/groovy/com/github/hauner/openapi/spring/writer/java/PathParameterAnnotationWriterSpec.groovy

@@ -28,7 +28,8 @@ class PathParameterAnnotationWriterSpec extends Specification {
     def target = new StringWriter()
 
     void "write simple (required) path parameter" () {
-        def param = new PathParameter('foo', new StringDataType(), true, false)
+        def param = new PathParameter(
+            'foo', new StringDataType(), true, false, null)
 
         when:
         writer.write (target, param)
@@ -38,7 +39,8 @@ class PathParameterAnnotationWriterSpec extends Specification {
     }
 
     void "write simple (optional) path parameter" () {
-        def param = new PathParameter('foo', new StringDataType(), false, false)
+        def param = new PathParameter(
+            'foo', new StringDataType(), false, false, null)
 
         when:
         writer.write (target, param)
@@ -50,7 +52,7 @@ class PathParameterAnnotationWriterSpec extends Specification {
     void "write simple (optional with default) path parameter" () {
         def param = new PathParameter('foo',
             new StringDataType(createConstraints ('bar'), false),
-            false, false)
+            false, false, null)
 
         when:
         writer.write (target, param)

src/test/groovy/com/github/hauner/openapi/spring/writer/java/QueryParameterAnnotationWriterSpec.groovy

@@ -29,7 +29,8 @@ class QueryParameterAnnotationWriterSpec extends Specification {
     def target = new StringWriter()
 
     void "write simple (required) query parameter" () {
-        def param = new QueryParameter('foo', new StringDataType(), true, false)
+        def param = new QueryParameter(
+            'foo', new StringDataType(), true, false, null)
 
         when:
         writer.write (target, param)
@@ -39,7 +40,8 @@ class QueryParameterAnnotationWriterSpec extends Specification {
     }
 
     void "write simple (optional) query parameter" () {
-        def param = new QueryParameter('foo', new StringDataType(), false, false)
+        def param = new QueryParameter(
+            'foo', new StringDataType(), false, false, null)
 
         when:
         writer.write (target, param)
@@ -51,7 +53,7 @@ class QueryParameterAnnotationWriterSpec extends Specification {
     void "write simple (optional with default) query parameter" () {
         def param = new QueryParameter('foo',
             new StringDataType(new DataTypeConstraints(defaultValue: 'bar'), false),
-            false, false)
+            false, false, null)
 
         when:
         writer.write (target, param)
@@ -68,7 +70,8 @@ class QueryParameterAnnotationWriterSpec extends Specification {
                     foo1: new StringDataType (),
                     foo2: new StringDataType ()
                 ], null, false
-            ), false, false)
+            ), false, false, null
+        )
 
         when:
         writer.write (target, param)