Skip to content
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

[typescript-angular] fix: when model property name is sanitized, use instead original property name within quotes in mustache template #19353

Conversation

davidediak
Copy link
Contributor

@davidediak davidediak commented Aug 14, 2024

Fixes #19352

Technical committee

@TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @topce (2018/10) @akehir (2019/07) @petejohansonxo (2019/11) @amakhrov (2020/02) @davidgamero (2022/03) @mkusaka (2022/04)

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 
    ./bin/generate-samples.sh ./bin/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (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.6.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.

… instead original property name within quotes in mustache template
@davidediak davidediak changed the title fix: typescript-angular -> when model property name is sanitized, use instead original property name within quotes in mustache template [typescript-angular] fix: when model property name is sanitized, use instead original property name within quotes in mustache template Aug 14, 2024
Copy link
Member

@macjohnny macjohnny left a comment

Choose a reason for hiding this comment

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

Thanks for your contribution!
It seems this change is not backwards-compatible, but on the other hand, I guess the current state for this use case is just broken, so its fine to fix it.
@wing328 can you approve for core?

@davidediak
Copy link
Contributor Author

@wing328 do you plan on merging this soon or there are any issues?

@macjohnny macjohnny requested a review from wing328 August 27, 2024 12:14
@LPCmedia
Copy link

LPCmedia commented Aug 27, 2024

  • 1 on this feature please. in our case some props have - in them for some reason.

@@ -3884,6 +3884,7 @@ public CodegenProperty fromProperty(String name, Schema p, boolean required, boo

property.name = toVarName(name);
property.baseName = name;
property.setHasSanitizedName(!property.baseName.equals(property.name));
Copy link
Member

Choose a reason for hiding this comment

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

FYI. @OpenAPITools/generator-core-team

@wing328
Copy link
Member

wing328 commented Aug 29, 2024

can we add a test model with the property name in question to the test spec used by the typescript-angular petstore (fake) sample so that we know what the output looks like and the result works without issue?

@wing328
Copy link
Member

wing328 commented Aug 29, 2024

when you've time, can you also please PM me via Slack?

https://join.slack.com/t/openapi-generator/shared_invite/zt-12jxxd7p2-XUeQM~4pzsU9x~eGLQqX2g

@wing328
Copy link
Member

wing328 commented Aug 30, 2024

as discussed, I think this enhancement should only be applied to "original" modelPropertyNaming (when such option is enabled)

you tried the "original" modelPropertyNaming option before but it didn't work for you.

i'll investigate further over the weekend.

@wing328
Copy link
Member

wing328 commented Sep 2, 2024

closed via #19508

thanks for the PR

please pull the latest master to give it a try when you've time

@macjohnny macjohnny closed this Sep 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants