openapi-generator icon indicating copy to clipboard operation
openapi-generator copied to clipboard

[KOTLIN][SPRING] fix - properly escape dollar and double quotes

Open Picazsoo opened this issue 3 months ago • 0 comments

This PR fixes many identified issues with improper escaping of dollar symbol in open api spec. In kotlin, $ has a special meaning in strings and thus needs to be properly escaped by prepending it with backslash \$. In multi-line kotlin strings, the escaping is done by transforming $ into ${'$'}. This merge request fixes the issue everywhere to make compilation possible.

I also unified look and setup of kotlin spring tests where possible. I removed a lot of code repetition and although I am still not super happy with it, the unified structure should make future refactoring a bit easier I presume.

I also checked and fixed any places I could identify where a duplicate escaping of special chars occurred or was simply not needed in the first place.

I fixed all of these (and their {{{.}}} variants):

{{{defaultValue}}}
{{{baseName}}}
{{{path}}}
{{{description}}}
{{{summary}}}
{{{notes}}}
{{{message}}}

I partially covered the fixes by unit tests and partially by introducing new generated samples (and adding the to the compile check pipeline) and by adjusting existing samples to include the potentially problematic strings (param names, descriptions, default values, etc)

For code review of the changed kotlin spring tests I strongly encourage the github setting of ignoring whitespace differences.

PR checklist

  • [x] Read the contribution guidelines.
  • [x] 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.
  • [x] 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 WSL) 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.
  • [x] 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)
  • [x] If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • [x] If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request. - Tagging: @karismann, @Zomzog, @andrewemery, @4brunu, @yutaka0m, @stefankoppier, @e5l

Picazsoo avatar Nov 26 '25 23:11 Picazsoo