fix(java-spring): use lambdaEscapeDoubleQuote in api.mustache#24205
Open
KannaKim wants to merge 2 commits into
Open
fix(java-spring): use lambdaEscapeDoubleQuote in api.mustache#24205KannaKim wants to merge 2 commits into
KannaKim wants to merge 2 commits into
Conversation
Uses around and variables to prevent compilation errors and HTML-escaped quotes.
Contributor
There was a problem hiding this comment.
1 issue found across 3 files
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
- 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
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 ( Could you please review these changes when you have a moment? cc @cachescrubber @welshm @MelleD @atextor @manedev79 @javisst @borsch @banlevente @Zomzog @martin-mfg |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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@Tagannotation and generated invalid HTML entities (") inside the @operation tags array.Changes
@Tag(name = ...)and@Api(value = ...)) and method-level annotations (@Operation(tags = ...)and@ApiOperation(tags = ...)) inJavaSpring/api.mustacheto wraptagNameandtaginside thelambdaEscapeDoubleQuotemustache lambda.modules/openapi-generator/src/test/resources/3_0/issue_22629.yaml.testStringQuotesInTags_Issue22629()inSpringCodegenTest.javato verify correct escaping.PR checklist
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.
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 usingescapeTextinSpringCodegenand triple-brace rendering inJavaSpring/api.mustachefor@Tag,@Operation, and@ApiOperation. Fixes #22629.tagNameandtaginSpringCodegenviaescapeText.{{{tag}}}inJavaSpring/api.mustacheto avoid HTML-entity encoding; remove thelambdaEscapeDoubleQuoteapproach.issue_22629.yamlandtestStringQuotesInTags_Issue22629to verify quotes, backslashes, and newlines in@Tagand@Operation(tags = ...).Written for commit ec924d3. Summary will update on new commits.