Set default values to not required parameters (#1722)

Fixed #1719
micronaut-projects · Aug 23, 2024 · 911d6c9 · 911d6c9
1 parent 7926088
commit 911d6c9
Show file tree

Hide file tree

Showing 8 changed files with 19 additions and 5 deletions.
diff --git a/...-generator/src/main/java/io/micronaut/openapi/generator/AbstractMicronautJavaCodegen.java b/...-generator/src/main/java/io/micronaut/openapi/generator/AbstractMicronautJavaCodegen.java
@@ -1878,6 +1878,7 @@ public void setDateTimeLibrary(String name) {
     public boolean getUseInlineModelResolver() {
         return false;
     }
+
     @Override
     public void postProcess() {
         // disable output donation suggestion

diff --git a/...nerator/src/main/resources/templates/kotlin-micronaut/client/params/cookieParams.mustache b/...nerator/src/main/resources/templates/kotlin-micronaut/client/params/cookieParams.mustache
@@ -1 +1 @@
-{{#isCookieParam}}@CookieValue({{#defaultValue}}value = {{/defaultValue}}"{{baseName}}"{{#defaultValue}}, defaultValue = "{{defaultValue}}"{{/defaultValue}}) {{>common/params/validation}}{{>client/params/type}}{{{paramName}}}: {{{vendorExtensions.typeWithEnumWithGenericAnnotations}}}{{#vendorExtensions.defaultValueInit}} = {{{.}}}{{/vendorExtensions.defaultValueInit}}{{^vendorExtensions.defaultValueInit}}{{#isNullable}} = null{{/isNullable}}{{/vendorExtensions.defaultValueInit}}{{/isCookieParam}}
+{{#isCookieParam}}@CookieValue({{#defaultValue}}value = {{/defaultValue}}"{{baseName}}"{{#defaultValue}}, defaultValue = "{{defaultValue}}"{{/defaultValue}}) {{>common/params/validation}}{{>client/params/type}}{{{paramName}}}: {{{vendorExtensions.typeWithEnumWithGenericAnnotations}}}{{#vendorExtensions.defaultValueInit}} = {{{.}}}{{/vendorExtensions.defaultValueInit}}{{^vendorExtensions.defaultValueInit}}{{#isNullable}} = null{{/isNullable}}{{^isNullable}}{{^required}} = null{{/required}}{{/isNullable}}{{/vendorExtensions.defaultValueInit}}{{/isCookieParam}}
diff --git a/...nerator/src/main/resources/templates/kotlin-micronaut/client/params/headerParams.mustache b/...nerator/src/main/resources/templates/kotlin-micronaut/client/params/headerParams.mustache
@@ -1 +1 @@
-{{#isHeaderParam}}@Header({{#defaultValue}}name = {{/defaultValue}}"{{baseName}}"{{#defaultValue}}, defaultValue = "{{{defaultValue}}}"{{/defaultValue}}) {{>common/params/validation}}{{>client/params/type}}{{{paramName}}}: {{{vendorExtensions.typeWithEnumWithGenericAnnotations}}}{{#vendorExtensions.defaultValueInit}} = {{{.}}}{{/vendorExtensions.defaultValueInit}}{{^vendorExtensions.defaultValueInit}}{{#isNullable}} = null{{/isNullable}}{{/vendorExtensions.defaultValueInit}}{{/isHeaderParam}}
+{{#isHeaderParam}}@Header({{#defaultValue}}name = {{/defaultValue}}"{{baseName}}"{{#defaultValue}}, defaultValue = "{{{defaultValue}}}"{{/defaultValue}}) {{>common/params/validation}}{{>client/params/type}}{{{paramName}}}: {{{vendorExtensions.typeWithEnumWithGenericAnnotations}}}{{#vendorExtensions.defaultValueInit}} = {{{.}}}{{/vendorExtensions.defaultValueInit}}{{^vendorExtensions.defaultValueInit}}{{#isNullable}} = null{{/isNullable}}{{^isNullable}}{{^required}} = null{{/required}}{{/isNullable}}{{/vendorExtensions.defaultValueInit}}{{/isHeaderParam}}
diff --git a/...generator/src/main/resources/templates/kotlin-micronaut/client/params/pathParams.mustache b/...generator/src/main/resources/templates/kotlin-micronaut/client/params/pathParams.mustache
@@ -1 +1 @@
-{{#isPathParam}}@PathVariable({{#defaultValue}}name = {{/defaultValue}}"{{baseName}}"{{#defaultValue}}, defaultValue = "{{{defaultValue}}}"{{/defaultValue}}) {{>common/params/validation}}{{>client/params/type}}{{{paramName}}}: {{{vendorExtensions.typeWithEnumWithGenericAnnotations}}}{{#vendorExtensions.defaultValueInit}} = {{{.}}}{{/vendorExtensions.defaultValueInit}}{{^vendorExtensions.defaultValueInit}}{{#isNullable}} = null{{/isNullable}}{{/vendorExtensions.defaultValueInit}}{{/isPathParam}}
+{{#isPathParam}}@PathVariable({{#defaultValue}}name = {{/defaultValue}}"{{baseName}}"{{#defaultValue}}, defaultValue = "{{{defaultValue}}}"{{/defaultValue}}) {{>common/params/validation}}{{>client/params/type}}{{{paramName}}}: {{{vendorExtensions.typeWithEnumWithGenericAnnotations}}}{{#vendorExtensions.defaultValueInit}} = {{{.}}}{{/vendorExtensions.defaultValueInit}}{{^vendorExtensions.defaultValueInit}}{{#isNullable}} = null{{/isNullable}}{{^isNullable}}{{^required}} = null{{/required}}{{/isNullable}}{{/vendorExtensions.defaultValueInit}}{{/isPathParam}}
diff --git a/...enerator/src/main/resources/templates/kotlin-micronaut/client/params/queryParams.mustache b/...enerator/src/main/resources/templates/kotlin-micronaut/client/params/queryParams.mustache
@@ -1 +1 @@
-{{#isQueryParam}}@QueryValue({{#defaultValue}}value = {{/defaultValue}}"{{{baseName}}}"{{!default value}}{{#defaultValue}}, defaultValue = "{{{defaultValue}}}"{{/defaultValue}}) {{!validation and type}}{{>common/params/validation}}{{>client/params/type}}{{{paramName}}}: {{{vendorExtensions.typeWithEnumWithGenericAnnotations}}}{{#vendorExtensions.defaultValueInit}} = {{{.}}}{{/vendorExtensions.defaultValueInit}}{{^vendorExtensions.defaultValueInit}}{{#isNullable}} = null{{/isNullable}}{{/vendorExtensions.defaultValueInit}}{{/isQueryParam}}
+{{#isQueryParam}}@QueryValue({{#defaultValue}}value = {{/defaultValue}}"{{{baseName}}}"{{!default value}}{{#defaultValue}}, defaultValue = "{{{defaultValue}}}"{{/defaultValue}}) {{!validation and type}}{{>common/params/validation}}{{>client/params/type}}{{{paramName}}}: {{{vendorExtensions.typeWithEnumWithGenericAnnotations}}}{{#vendorExtensions.defaultValueInit}} = {{{.}}}{{/vendorExtensions.defaultValueInit}}{{^vendorExtensions.defaultValueInit}}{{#isNullable}} = null{{/isNullable}}{{^isNullable}}{{^required}} = null{{/required}}{{/isNullable}}{{/vendorExtensions.defaultValueInit}}{{/isQueryParam}}
diff --git a/...enerator/src/test/java/io/micronaut/openapi/generator/JavaMicronautClientCodegenTest.java b/...enerator/src/test/java/io/micronaut/openapi/generator/JavaMicronautClientCodegenTest.java
@@ -539,6 +539,7 @@ void testParamsWithDefaultValue() {
         String path = outputPath + "src/main/java/org/openapitools/";
 
         assertFileContains(path + "api/DefaultApi.java",
+            "@QueryValue(\"ids\") @Nullable List<@NotNull Integer> ids",
             "@PathVariable(name = \"apiVersion\", defaultValue = \"v5\") @Nullable BrowseSearchOrdersApiVersionParameter apiVersio",
             "@Header(name = \"Content-Type\", defaultValue = \"application/json\") @Nullable String contentType"
         );

diff --git a/...erator/src/test/java/io/micronaut/openapi/generator/KotlinMicronautClientCodegenTest.java b/...erator/src/test/java/io/micronaut/openapi/generator/KotlinMicronautClientCodegenTest.java
@@ -502,7 +502,7 @@ void testCommonPathParametersWithRef() {
 
         assertFileContains(path + "api/WeatherForecastApisApi.kt", "@Get(\"/v1/forecast/{id}\")",
             "@PathVariable(\"id\") @NotNull id: String,",
-            "@QueryValue(\"hourly\") @Nullable hourly: List<V1ForecastIdGetHourlyParameterInner>?,");
+            "@QueryValue(\"hourly\") @Nullable hourly: List<V1ForecastIdGetHourlyParameterInner>? = null,");
 
         assertFileContains(path + "model/V1ForecastIdGetHourlyParameterInner.kt",
             "enum class V1ForecastIdGetHourlyParameterInner(",
@@ -594,6 +594,7 @@ void testParamsWithDefaultValue() {
         String path = outputPath + "src/main/kotlin/org/openapitools/";
 
         assertFileContains(path + "api/DefaultApi.kt",
+            "@QueryValue(\"ids\") @Nullable ids: List<@NotNull Int>? = null,",
             "@Header(\"X-Favor-Token\") @Nullable xFavorToken: String? = null,",
             "@PathVariable(name = \"apiVersion\", defaultValue = \"v5\") @Nullable apiVersion: BrowseSearchOrdersApiVersionParameter? = BrowseSearchOrdersApiVersionParameter.V5,",
             "@Header(name = \"Content-Type\", defaultValue = \"application/json\") @Nullable contentType: String? = \"application/json\""

diff --git a/openapi-generator/src/test/resources/3_0/params-with-default-value.yml b/openapi-generator/src/test/resources/3_0/params-with-default-value.yml
@@ -8,6 +8,7 @@ paths:
       summary: 'Browser/search multiple order'
       operationId: browseSearchOrders
       parameters:
+        - $ref: '#/components/parameters/ids'
         - $ref: '#/components/parameters/XFavorToken'
         - $ref: '#/components/parameters/ApiVersion'
         - $ref: '#/components/parameters/ContentType'
@@ -36,6 +37,16 @@ components:
           - v5
           - v6
           - v7
+    ids:
+      name: ids
+      in: query
+      required: false
+      description: if passed will return all active orders for a given ids
+      schema:
+        type: array
+        items:
+          type: integer
+        default: null
     ContentType:
       name: Content-Type
       in: header