Skip to content

[typescript-fetch] to fix incorrect parsing with additional properties #20923

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ export class {{classname}} extends runtime.BaseAPI {
{{/isEnumRef}}
{{^isEnumRef}}
{{^withoutRuntimeChecks}}
formParams.append('{{baseName}}', new Blob([JSON.stringify({{{dataType}}}ToJSON(requestParameters['{{paramName}}']))], { type: "application/json", }));
formParams.append('{{baseName}}', new Blob([JSON.stringify({{returnType}}ToJSON(requestParameters['{{paramName}}']))], { type: "application/json", }));
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we add a fixture (generated sample) to the repository that shows this change? Or have the samples not been regenerated?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the only real changes I got from running generate-samples were CRLF/LF changes.
Tried again recently and this is pretty much all the output:
image

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@joscha Okay, so I retried on WSL and it seems the package-lock.json was the only real change

{{/withoutRuntimeChecks}}{{#withoutRuntimeChecks}}
formParams.append('{{baseName}}', new Blob([JSON.stringify(requestParameters['{{paramName}}'])], { type: "application/json", }));
{{/withoutRuntimeChecks}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -347,6 +347,31 @@ public void testGeneratedFilenamesInCamelCaseWithAdditionalModelPrefix() throws
TestUtils.assertFileExists(Paths.get(output + "/apis/petControllerApi.ts"));
}

@Test(description = "Issue #20195")
public void givenObjectHasAdditionalPropertiesWhenGenerateThenIndexSignatureNotUsedToGenerateMethodName() throws IOException {
File output = Files.createTempDirectory("test").toFile().getCanonicalFile();
output.deleteOnExit();

TypeScriptFetchClientCodegen clientCodegen = new TypeScriptFetchClientCodegen();
clientCodegen.setWithoutRuntimeChecks(false);
clientCodegen.setOutputDir(output.getAbsolutePath());

Map<String, Object> properties = new HashMap<>();
properties.put(TypeScriptFetchClientCodegen.WITH_INTERFACES, true);
properties.put(CodegenConstants.ENUM_PROPERTY_NAMING, "original");
clientCodegen.additionalProperties().putAll(properties);

DefaultGenerator defaultGenerator = new DefaultGenerator();
defaultGenerator.opts(
new ClientOptInput().openAPI(TestUtils.parseSpec("src/test/resources/bugs/issue_20195.json"))
.config(clientCodegen)
).generate();

String outputPath = output.getAbsolutePath();
Path exampleApiPath = Paths.get(outputPath + "/apis/ExampleApi.ts");
TestUtils.assertFileContains(exampleApiPath, "new Blob([JSON.stringify(ResponseOfStringToJSON");
}

private static File generate(Map<String, Object> properties) throws IOException {
File output = Files.createTempDirectory("test").toFile();
output.deleteOnExit();
Expand Down
77 changes: 77 additions & 0 deletions modules/openapi-generator/src/test/resources/bugs/issue_20195.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
{
"openapi": "3.0.1",
"info": {
"title": "Sample API",
"description": "This is sample api",
"version": "v1"
},
"paths": {
"/example_api_101": {
"post": {
"tags": [
"Example"
],
"summary": "Process Auth",
"parameters": [
{
"name": "Id",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"paRes": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Form sent for Authentication"
}
}
},
"encoding": {
"paRes": {
"style": "form"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseOfString"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"ResponseOfString": {
"type": "object",
"properties": {
"message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
}
}
}

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading