From bbcc510c695135abde25fa86db25fc4a2073d5fa Mon Sep 17 00:00:00 2001 From: Wiebren Braakman Date: Fri, 4 Sep 2026 20:22:33 +0200 Subject: [PATCH] fix: [dart] explode object query parameters MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit A query parameter whose schema is an object and whose style/explode are left at their defaults — style: form, explode: true — must go on the wire as one parameter per entry, keyed by the property name alone. The dart client handed the whole map to _queryParams, which stringified it with Map.toString() into a single parameter (filter={tld: com, createdDate:gte: 2023-01-01}). The generated api now iterates an exploded map entry by entry at the call site; _queryParams is left alone, since it never receives style or explode and is still the right fallback for every other parameter. A free-form object is typed Object in dart and needs a cast to Map; a declared map does not. deepObject and explode: false objects keep their previous wire format, byte for byte. The new test fixture covers the four style/explode combinations that decide the wire format; the test fails without the template change. Co-Authored-By: Claude Fable 5 Claude-Session: https://claude.ai/code/session_01CxDNCjqJycKTfzVWg2SeTJ --- .../src/main/resources/dart2/api.mustache | 16 ++++++ .../codegen/dart/DartClientCodegenTest.java | 27 ++++++++++ .../3_0/exploded-object-query-param.yaml | 51 +++++++++++++++++++ .../lib/api/fake_api.dart | 3 +- 4 files changed, 96 insertions(+), 1 deletion(-) create mode 100644 modules/openapi-generator/src/test/resources/3_0/exploded-object-query-param.yaml diff --git a/modules/openapi-generator/src/main/resources/dart2/api.mustache b/modules/openapi-generator/src/main/resources/dart2/api.mustache index 1c995009e018..6c7ffbfdd0a1 100644 --- a/modules/openapi-generator/src/main/resources/dart2/api.mustache +++ b/modules/openapi-generator/src/main/resources/dart2/api.mustache @@ -67,7 +67,23 @@ class {{{classname}}} { {{^required}} if ({{{paramName}}} != null) { {{/required}} + {{#isMap}} + {{#isExplode}} + {{^isDeepObject}} + // form style explodes an object into one query parameter per entry, keyed by the property name alone + {{#isFreeFormObject}}({{{paramName}}} as Map){{/isFreeFormObject}}{{^isFreeFormObject}}{{{paramName}}}{{/isFreeFormObject}}.forEach((entryKey, entryValue) => queryParams.addAll(_queryParams('', entryKey.toString(), entryValue))); + {{/isDeepObject}} + {{#isDeepObject}} queryParams.addAll(_queryParams('{{{collectionFormat}}}', '{{{baseName}}}', {{{paramName}}})); + {{/isDeepObject}} + {{/isExplode}} + {{^isExplode}} + queryParams.addAll(_queryParams('{{{collectionFormat}}}', '{{{baseName}}}', {{{paramName}}})); + {{/isExplode}} + {{/isMap}} + {{^isMap}} + queryParams.addAll(_queryParams('{{{collectionFormat}}}', '{{{baseName}}}', {{{paramName}}})); + {{/isMap}} {{^required}} } {{/required}} diff --git a/modules/openapi-generator/src/test/java/org/openapitools/codegen/dart/DartClientCodegenTest.java b/modules/openapi-generator/src/test/java/org/openapitools/codegen/dart/DartClientCodegenTest.java index 2215908d3d65..d8101905cae9 100644 --- a/modules/openapi-generator/src/test/java/org/openapitools/codegen/dart/DartClientCodegenTest.java +++ b/modules/openapi-generator/src/test/java/org/openapitools/codegen/dart/DartClientCodegenTest.java @@ -137,6 +137,33 @@ public void testObjectArrayDoesNotUseListFromJson() throws Exception { TestUtils.assertFileContains(modelFile.toPath(), "cast"); } + @Test(description = "Verify an object query parameter is exploded, whether or not it declares its properties") + public void testExplodedObjectQueryParameter() throws Exception { + List files = generateDartNativeFromSpec( + "src/test/resources/3_0/exploded-object-query-param.yaml"); + + File apiFile = files.stream() + .filter(f -> f.getName().equals("default_api.dart")) + .findFirst() + .orElseThrow(() -> new AssertionError("default_api.dart not found in generated files")); + + // form style with explode - the default - puts every entry on the wire under its own + // property name. Handing the whole map to _queryParams stringifies it with + // Map.toString(), which is what used to happen. + TestUtils.assertFileContains(apiFile.toPath(), + "(filter as Map).forEach((entryKey, entryValue) => queryParams.addAll(_queryParams('', entryKey.toString(), entryValue)));"); + TestUtils.assertFileNotContains(apiFile.toPath(), "_queryParams('', 'filter', filter)"); + + // a declared map behaves the same way, and needs no cast + TestUtils.assertFileContains(apiFile.toPath(), + "typedFilter.forEach((entryKey, entryValue) => queryParams.addAll(_queryParams('', entryKey.toString(), entryValue)));"); + + // deepObject and form without explode both keep a single parameter + TestUtils.assertFileContains(apiFile.toPath(), + "_queryParams('', 'deepFilter', deepFilter)", + "_queryParams('', 'flatFilter', flatFilter)"); + } + @Test(description = "Enum properties with defaults should emit enum constructor, not string literal") public void testEnumDefaultUsesEnumConstructor() throws Exception { List files = generateDartNativeFromSpec( diff --git a/modules/openapi-generator/src/test/resources/3_0/exploded-object-query-param.yaml b/modules/openapi-generator/src/test/resources/3_0/exploded-object-query-param.yaml new file mode 100644 index 000000000000..fd6fce7d5807 --- /dev/null +++ b/modules/openapi-generator/src/test/resources/3_0/exploded-object-query-param.yaml @@ -0,0 +1,51 @@ +openapi: 3.0.3 +info: + title: Exploded object query parameters + description: > + Object typed query parameters, covering the four combinations of style and explode that + decide how an object is put on the wire. The free-form variants matter because a + free-form object is flagged isMap but not isContainer. + version: 1.0.0 +servers: + - url: localhost:8080 +paths: + /items: + get: + operationId: listItems + parameters: + # style and explode both left out, so the form/true defaults apply: every entry + # becomes its own parameter, keyed by the property name alone. + - in: query + name: filter + schema: + type: object + # the same, but declared as a map rather than as a free-form object + - in: query + name: typedFilter + schema: + type: object + additionalProperties: + type: string + # deepObject nests each entry under the parameter name: deepFilter[key]=value + - in: query + name: deepFilter + style: deepObject + explode: true + schema: + type: object + # form without explode keeps a single parameter carrying the whole object + - in: query + name: flatFilter + style: form + explode: false + schema: + type: object + responses: + '200': + description: a list of items + content: + application/json: + schema: + type: array + items: + type: string diff --git a/samples/openapi3/client/petstore/dart2/petstore_client_lib_fake/lib/api/fake_api.dart b/samples/openapi3/client/petstore/dart2/petstore_client_lib_fake/lib/api/fake_api.dart index c61373a87937..35e2a4864080 100644 --- a/samples/openapi3/client/petstore/dart2/petstore_client_lib_fake/lib/api/fake_api.dart +++ b/samples/openapi3/client/petstore/dart2/petstore_client_lib_fake/lib/api/fake_api.dart @@ -1382,7 +1382,8 @@ class FakeApi { queryParams.addAll(_queryParams('csv', 'url', url)); queryParams.addAll(_queryParams('multi', 'context', context)); if (language != null) { - queryParams.addAll(_queryParams('', 'language', language)); + // form style explodes an object into one query parameter per entry, keyed by the property name alone + language.forEach((entryKey, entryValue) => queryParams.addAll(_queryParams('', entryKey.toString(), entryValue))); } queryParams.addAll(_queryParams('', 'allowEmpty', allowEmpty));