Skip to content

fix(java-spring): use lambdaEscapeDoubleQuote in api.mustache#24205

Open
KannaKim wants to merge 2 commits into
OpenAPITools:masterfrom
KannaKim:issue-22629
Open

fix(java-spring): use lambdaEscapeDoubleQuote in api.mustache#24205
KannaKim wants to merge 2 commits into
OpenAPITools:masterfrom
KannaKim:issue-22629

Conversation

@KannaKim

@KannaKim KannaKim commented Jul 6, 2026

Copy link
Copy Markdown

Fixes #22629

This PR fixes a bug in the Java/Spring generator where tag names and operation tags containing double quotes (e.g., My "quoted" api) were not correctly escaped. This previously caused Java syntax/compilation errors in the generated @Tag annotation and generated invalid HTML entities (") inside the @operation tags array.

Changes

  • Templates: Updated class-level annotations (@Tag(name = ...) and @Api(value = ...)) and method-level annotations (@Operation(tags = ...) and @ApiOperation(tags = ...)) in JavaSpring/api.mustache to wrap tagName and tag inside the lambdaEscapeDoubleQuote mustache lambda.
  • Test Fixture: Added a minimal OpenAPI reproduction spec at modules/openapi-generator/src/test/resources/3_0/issue_22629.yaml.
  • Unit Test: Added the corresponding unit test case testStringQuotesInTags_Issue22629() in SpringCodegenTest.java to verify correct escaping.

PR checklist

  • Read the contribution guidelines.
  • 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.
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Summary by cubic

Escapes quotes, backslashes, and newlines in Java/Spring tag names and tags to prevent compilation errors and " artifacts in generated annotations by using escapeText in SpringCodegen and triple-brace rendering in JavaSpring/api.mustache for @Tag, @Operation, and @ApiOperation. Fixes #22629.

  • Bug Fixes
    • Escape tagName and tag in SpringCodegen via escapeText.
    • Render tags with {{{tag}}} in JavaSpring/api.mustache to avoid HTML-entity encoding; remove the lambdaEscapeDoubleQuote approach.
    • Add issue_22629.yaml and testStringQuotesInTags_Issue22629 to verify quotes, backslashes, and newlines in @Tag and @Operation(tags = ...).

Written for commit ec924d3. Summary will update on new commits.

Review in cubic

Uses  around  and  variables to prevent compilation errors and HTML-escaped quotes.

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

1 issue found across 3 files

Reply with feedback, questions, or to request a fix.

Re-trigger cubic

Comment thread modules/openapi-generator/src/main/resources/JavaSpring/api.mustache Outdated
- Escape OpenAPI tags and tagNames directly in Java using `escapeText` instead of a custom template lambda.
- This ensures that backslashes, newlines, and double quotes are correctly escaped, preventing Java compilation failures when tags contain special characters.
- Revert the template-level `lambdaEscapeDoubleQuote` addition in api.mustache and render variables using triple curly braces `{{{...}}}` to prevent HTML-entity escaping.
- Add test coverage verifying quotes, backslashes, and newlines in tags for both `@Tag` and `@Operation(tags = ...)` annotations.

Fixes OpenAPITools#22629
@KannaKim

KannaKim commented Jul 6, 2026

Copy link
Copy Markdown
Author

Hi Java Spring Technical Committee,

I've updated this PR to address the issue of incorrectly escaped string quotes, backslashes, and newlines in generated Java API annotations (@Tag and @Operation).

Could you please review these changes when you have a moment?

cc @cachescrubber @welshm @MelleD @atextor @manedev79 @javisst @borsch @banlevente @Zomzog @martin-mfg

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG][JAVA] Java string quotes incorrectly escaped in value strings

1 participant