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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Mar 24, 2025
Merged

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

merged 4 commits into from
Mar 24, 2025

Conversation

DavidGrath
Copy link
Contributor

@DavidGrath DavidGrath commented Mar 18, 2025 •
edited by wing328
Loading

Added test givenObjectHasAdditionalPropertiesWhenGenerateThenIndexSignatureNotUsedToGenerateMethodName to verify that it works. Also opened the newly generated folder in VSCode and found no syntax errors.
@joscha please help review

to close #20195

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples: 
    ./mvnw clean package || exit
./bin/generate-samples.sh ./bin/configs/*.yaml || exit
./bin/utils/export_docs_generators.sh || exit
    (For Windows users, please run the script in Git BASH)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@joscha
Copy link
Contributor

joscha commented Mar 19, 2025

refs #20195

joscha
joscha reviewed Mar 19, 2025
View reviewed changes
Copy link
Contributor

@joscha joscha left a comment

Choose a reason for hiding this comment

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

🎉

docs/generators/fsharp-functions.md Outdated
@@ -34,7 +34,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|sourceFolder|source folder for generated code| |OpenAPI/src|
|sourceFolder|source folder for generated code| |OpenAPI\src|
Copy link
Contributor

Choose a reason for hiding this comment

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

We should revert these - probably because regeneration was done on windows?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hello, thank you for the feedback.
I also think it was because of Windows. I'll try using a Linux machine instead to effectively undo my own changes

Copy link
Member

Choose a reason for hiding this comment

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

you can use WSL instead

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you. Done

you can use WSL instead

modules/openapi-generator/src/main/resources/typescript-fetch/apis.mustache
@@ -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

@DavidGrath
Copy link
Contributor Author

Good Day @joscha ,
Do you think it's good to go now?

joscha
joscha approved these changes Mar 22, 2025
View reviewed changes
Copy link
Contributor

@joscha joscha left a comment

Choose a reason for hiding this comment

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

Nice. Will need @macjohnny to merge.

@wing328 wing328 changed the title Fix issue #20195 [typescript-fetch] to fix incorrect parsing with additional properties Mar 23, 2025
@wing328 wing328 added this to the 7.13.0 milestone Mar 23, 2025
@macjohnny macjohnny merged commit 0becb3f into OpenAPITools:master Mar 24, 2025
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wing328 wing328 wing328 left review comments

@joscha joscha joscha approved these changes

Assignees
No one assigned
Labels
Client: TypeScript Issue: Bug
Projects
None yet
Milestone
7.13.0
Development

Successfully merging this pull request may close these issues.

[BUG] [typescript-fetch] Incorrect parsing with additional properties
4 participants
@DavidGrath @joscha @wing328 @macjohnny