[Java][OkHttp-Gson] fix: free form query parameters for okhttp-gson (#…

…19226)
OpenAPITools · Aug 15, 2024 · 38ebf0b · 38ebf0b
1 parent 05c1093
commit 38ebf0b
Show file tree

Hide file tree

Showing 20 changed files with 561 additions and 1 deletion.
diff --git a/modules/openapi-generator/src/main/resources/Java/libraries/okhttp-gson/ApiClient.mustache b/modules/openapi-generator/src/main/resources/Java/libraries/okhttp-gson/ApiClient.mustache
@@ -987,6 +987,30 @@ public class ApiClient {
     }
     {{/dynamicOperations}}
 
+    /**
+    * Formats the specified free-form query parameters to a list of {@code Pair} objects.
+    *
+    * @param value The free-form query parameters.
+    * @return A list of {@code Pair} objects.
+    */
+    public List<Pair> freeFormParameterToPairs(Object value) {
+        List<Pair> params = new ArrayList<>();
+
+        // preconditions
+        if (value == null || !(value instanceof Map )) {
+            return params;
+        }
+
+        final Map<String, Object> valuesMap = (Map<String, Object>) value;
+
+        for (Map.Entry<String, Object> entry : valuesMap.entrySet()) {
+            params.add(new Pair(entry.getKey(), parameterToString(entry.getValue())));
+        }
+
+        return params;
+    }
+
+
     /**
      * Formats the specified collection path parameter to a string value.
      *

diff --git a/modules/openapi-generator/src/main/resources/Java/libraries/okhttp-gson/api.mustache b/modules/openapi-generator/src/main/resources/Java/libraries/okhttp-gson/api.mustache
@@ -169,7 +169,7 @@ public class {{classname}} {
         {{^dynamicOperations}}
         {{#queryParams}}
         if ({{paramName}} != null) {
-            {{#collectionFormat}}localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("{{{.}}}", {{/collectionFormat}}{{^collectionFormat}}localVarQueryParams.addAll(localVarApiClient.parameterToPair({{/collectionFormat}}"{{baseName}}", {{paramName}}));
+            {{#isFreeFormObject}}localVarQueryParams.addAll(localVarApiClient.freeFormParameterToPairs({{paramName}}));{{/isFreeFormObject}}{{^isFreeFormObject}}{{#collectionFormat}}localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("{{{.}}}", {{/collectionFormat}}{{^collectionFormat}}localVarQueryParams.addAll(localVarApiClient.parameterToPair({{/collectionFormat}}"{{baseName}}", {{paramName}}));{{/isFreeFormObject}}
         }
 
         {{/queryParams}}

diff --git a/.../test/resources/3_0/java/petstore-with-fake-endpoints-models-for-testing-okhttp-gson.yaml b/.../test/resources/3_0/java/petstore-with-fake-endpoints-models-for-testing-okhttp-gson.yaml
@@ -1092,6 +1092,21 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/FreeFormObjectTestClass'
+  /fake/free-form-query-parameters:
+    get:
+      parameters:
+        - in: "query"
+          name: "fixed"
+          schema:
+            type: "string"
+        - in: "query"
+          name: "free-form"
+          schema:
+            type: "object"
+          style: "form"
+      responses:
+        200:
+          description: OK
   /fake/test-query-parameters:
     put:
       tags:

diff --git a/...a/okhttp-gson-user-defined-templates/src/main/java/org/openapitools/client/ApiClient.java b/...a/okhttp-gson-user-defined-templates/src/main/java/org/openapitools/client/ApiClient.java
@@ -829,6 +829,30 @@ public List<Pair> parameterToPairs(String collectionFormat, String name, Collect
         return params;
     }
 
+    /**
+    * Formats the specified free-form query parameters to a list of {@code Pair} objects.
+    *
+    * @param value The free-form query parameters.
+    * @return A list of {@code Pair} objects.
+    */
+    public List<Pair> freeFormParameterToPairs(Object value) {
+        List<Pair> params = new ArrayList<>();
+
+        // preconditions
+        if (value == null || !(value instanceof Map )) {
+            return params;
+        }
+
+        final Map<String, Object> valuesMap = (Map<String, Object>) value;
+
+        for (Map.Entry<String, Object> entry : valuesMap.entrySet()) {
+            params.add(new Pair(entry.getKey(), parameterToString(entry.getValue())));
+        }
+
+        return params;
+    }
+
+
     /**
      * Formats the specified collection path parameter to a string value.
      *

diff --git a/...les/client/echo_api/java/okhttp-gson/src/main/java/org/openapitools/client/ApiClient.java b/...les/client/echo_api/java/okhttp-gson/src/main/java/org/openapitools/client/ApiClient.java
@@ -759,6 +759,30 @@ public List<Pair> parameterToPairs(String collectionFormat, String name, Collect
         return params;
     }
 
+    /**
+    * Formats the specified free-form query parameters to a list of {@code Pair} objects.
+    *
+    * @param value The free-form query parameters.
+    * @return A list of {@code Pair} objects.
+    */
+    public List<Pair> freeFormParameterToPairs(Object value) {
+        List<Pair> params = new ArrayList<>();
+
+        // preconditions
+        if (value == null || !(value instanceof Map )) {
+            return params;
+        }
+
+        final Map<String, Object> valuesMap = (Map<String, Object>) value;
+
+        for (Map.Entry<String, Object> entry : valuesMap.entrySet()) {
+            params.add(new Pair(entry.getKey(), parameterToString(entry.getValue())));
+        }
+
+        return params;
+    }
+
+
     /**
      * Formats the specified collection path parameter to a string value.
      *

diff --git a/...client/others/java/okhttp-gson-oneOf/src/main/java/org/openapitools/client/ApiClient.java b/...client/others/java/okhttp-gson-oneOf/src/main/java/org/openapitools/client/ApiClient.java
@@ -733,6 +733,30 @@ public List<Pair> parameterToPairs(String collectionFormat, String name, Collect
         return params;
     }
 
+    /**
+    * Formats the specified free-form query parameters to a list of {@code Pair} objects.
+    *
+    * @param value The free-form query parameters.
+    * @return A list of {@code Pair} objects.
+    */
+    public List<Pair> freeFormParameterToPairs(Object value) {
+        List<Pair> params = new ArrayList<>();
+
+        // preconditions
+        if (value == null || !(value instanceof Map )) {
+            return params;
+        }
+
+        final Map<String, Object> valuesMap = (Map<String, Object>) value;
+
+        for (Map.Entry<String, Object> entry : valuesMap.entrySet()) {
+            params.add(new Pair(entry.getKey(), parameterToString(entry.getValue())));
+        }
+
+        return params;
+    }
+
+
     /**
      * Formats the specified collection path parameter to a string value.
      *

diff --git a/...nt/others/java/okhttp-gson-streaming/src/main/java/org/openapitools/client/ApiClient.java b/...nt/others/java/okhttp-gson-streaming/src/main/java/org/openapitools/client/ApiClient.java
@@ -733,6 +733,30 @@ public List<Pair> parameterToPairs(String collectionFormat, String name, Collect
         return params;
     }
 
+    /**
+    * Formats the specified free-form query parameters to a list of {@code Pair} objects.
+    *
+    * @param value The free-form query parameters.
+    * @return A list of {@code Pair} objects.
+    */
+    public List<Pair> freeFormParameterToPairs(Object value) {
+        List<Pair> params = new ArrayList<>();
+
+        // preconditions
+        if (value == null || !(value instanceof Map )) {
+            return params;
+        }
+
+        final Map<String, Object> valuesMap = (Map<String, Object>) value;
+
+        for (Map.Entry<String, Object> entry : valuesMap.entrySet()) {
+            params.add(new Pair(entry.getKey(), parameterToString(entry.getValue())));
+        }
+
+        return params;
+    }
+
+
     /**
      * Formats the specified collection path parameter to a string value.
      *

diff --git a/...client/petstore/java/okhttp-gson-3.1/src/main/java/org/openapitools/client/ApiClient.java b/...client/petstore/java/okhttp-gson-3.1/src/main/java/org/openapitools/client/ApiClient.java
@@ -829,6 +829,30 @@ public List<Pair> parameterToPairs(String collectionFormat, String name, Collect
         return params;
     }
 
+    /**
+    * Formats the specified free-form query parameters to a list of {@code Pair} objects.
+    *
+    * @param value The free-form query parameters.
+    * @return A list of {@code Pair} objects.
+    */
+    public List<Pair> freeFormParameterToPairs(Object value) {
+        List<Pair> params = new ArrayList<>();
+
+        // preconditions
+        if (value == null || !(value instanceof Map )) {
+            return params;
+        }
+
+        final Map<String, Object> valuesMap = (Map<String, Object>) value;
+
+        for (Map.Entry<String, Object> entry : valuesMap.entrySet()) {
+            params.add(new Pair(entry.getKey(), parameterToString(entry.getValue())));
+        }
+
+        return params;
+    }
+
+
     /**
      * Formats the specified collection path parameter to a string value.
      *

diff --git a/...tore/java/okhttp-gson-awsv4signature/src/main/java/org/openapitools/client/ApiClient.java b/...tore/java/okhttp-gson-awsv4signature/src/main/java/org/openapitools/client/ApiClient.java
@@ -849,6 +849,30 @@ public List<Pair> parameterToPairs(String collectionFormat, String name, Collect
         return params;
     }
 
+    /**
+    * Formats the specified free-form query parameters to a list of {@code Pair} objects.
+    *
+    * @param value The free-form query parameters.
+    * @return A list of {@code Pair} objects.
+    */
+    public List<Pair> freeFormParameterToPairs(Object value) {
+        List<Pair> params = new ArrayList<>();
+
+        // preconditions
+        if (value == null || !(value instanceof Map )) {
+            return params;
+        }
+
+        final Map<String, Object> valuesMap = (Map<String, Object>) value;
+
+        for (Map.Entry<String, Object> entry : valuesMap.entrySet()) {
+            params.add(new Pair(entry.getKey(), parameterToString(entry.getValue())));
+        }
+
+        return params;
+    }
+
+
     /**
      * Formats the specified collection path parameter to a string value.
      *

diff --git a/...e/java/okhttp-gson-dynamicOperations/src/main/java/org/openapitools/client/ApiClient.java b/...e/java/okhttp-gson-dynamicOperations/src/main/java/org/openapitools/client/ApiClient.java
@@ -834,6 +834,30 @@ public List<Pair> parameterToPairs(Parameter param, Collection value) {
         return params;
     }
 
+    /**
+    * Formats the specified free-form query parameters to a list of {@code Pair} objects.
+    *
+    * @param value The free-form query parameters.
+    * @return A list of {@code Pair} objects.
+    */
+    public List<Pair> freeFormParameterToPairs(Object value) {
+        List<Pair> params = new ArrayList<>();
+
+        // preconditions
+        if (value == null || !(value instanceof Map )) {
+            return params;
+        }
+
+        final Map<String, Object> valuesMap = (Map<String, Object>) value;
+
+        for (Map.Entry<String, Object> entry : valuesMap.entrySet()) {
+            params.add(new Pair(entry.getKey(), parameterToString(entry.getValue())));
+        }
+
+        return params;
+    }
+
+
     /**
      * Formats the specified collection path parameter to a string value.
      *

diff --git a/...ore/java/okhttp-gson-group-parameter/src/main/java/org/openapitools/client/ApiClient.java b/...ore/java/okhttp-gson-group-parameter/src/main/java/org/openapitools/client/ApiClient.java
@@ -829,6 +829,30 @@ public List<Pair> parameterToPairs(String collectionFormat, String name, Collect
         return params;
     }
 
+    /**
+    * Formats the specified free-form query parameters to a list of {@code Pair} objects.
+    *
+    * @param value The free-form query parameters.
+    * @return A list of {@code Pair} objects.
+    */
+    public List<Pair> freeFormParameterToPairs(Object value) {
+        List<Pair> params = new ArrayList<>();
+
+        // preconditions
+        if (value == null || !(value instanceof Map )) {
+            return params;
+        }
+
+        final Map<String, Object> valuesMap = (Map<String, Object>) value;
+
+        for (Map.Entry<String, Object> entry : valuesMap.entrySet()) {
+            params.add(new Pair(entry.getKey(), parameterToString(entry.getValue())));
+        }
+
+        return params;
+    }
+
+
     /**
      * Formats the specified collection path parameter to a string value.
      *

diff --git a/...e/java/okhttp-gson-nullable-required/src/main/java/org/openapitools/client/ApiClient.java b/...e/java/okhttp-gson-nullable-required/src/main/java/org/openapitools/client/ApiClient.java
@@ -832,6 +832,30 @@ public List<Pair> parameterToPairs(String collectionFormat, String name, Collect
         return params;
     }
 
+    /**
+    * Formats the specified free-form query parameters to a list of {@code Pair} objects.
+    *
+    * @param value The free-form query parameters.
+    * @return A list of {@code Pair} objects.
+    */
+    public List<Pair> freeFormParameterToPairs(Object value) {
+        List<Pair> params = new ArrayList<>();
+
+        // preconditions
+        if (value == null || !(value instanceof Map )) {
+            return params;
+        }
+
+        final Map<String, Object> valuesMap = (Map<String, Object>) value;
+
+        for (Map.Entry<String, Object> entry : valuesMap.entrySet()) {
+            params.add(new Pair(entry.getKey(), parameterToString(entry.getValue())));
+        }
+
+        return params;
+    }
+
+
     /**
      * Formats the specified collection path parameter to a string value.
      *

diff --git a/...ore/java/okhttp-gson-parcelableModel/src/main/java/org/openapitools/client/ApiClient.java b/...ore/java/okhttp-gson-parcelableModel/src/main/java/org/openapitools/client/ApiClient.java
@@ -835,6 +835,30 @@ public List<Pair> parameterToPairs(String collectionFormat, String name, Collect
         return params;
     }
 
+    /**
+    * Formats the specified free-form query parameters to a list of {@code Pair} objects.
+    *
+    * @param value The free-form query parameters.
+    * @return A list of {@code Pair} objects.
+    */
+    public List<Pair> freeFormParameterToPairs(Object value) {
+        List<Pair> params = new ArrayList<>();
+
+        // preconditions
+        if (value == null || !(value instanceof Map )) {
+            return params;
+        }
+
+        final Map<String, Object> valuesMap = (Map<String, Object>) value;
+
+        for (Map.Entry<String, Object> entry : valuesMap.entrySet()) {
+            params.add(new Pair(entry.getKey(), parameterToString(entry.getValue())));
+        }
+
+        return params;
+    }
+
+
     /**
      * Formats the specified collection path parameter to a string value.
      *