Feature/fix values2#23632
Closed
Picazsoo wants to merge 8 commits intoOpenAPITools:masterfrom
Closed
Conversation
Contributor
There was a problem hiding this comment.
7 issues found across 146 files
Note: This PR contains a large number of files. cubic only reviews up to 75 files per PR, so some files may not have been reviewed. cubic prioritises the most important files to review.
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="samples/client/petstore/kotlin-jackson/docs/PetApi.md">
<violation number="1" location="samples/client/petstore/kotlin-jackson/docs/PetApi.md:111">
P2: Unescaped `<Pet>` in Markdown signatures is parsed as HTML and can render incorrectly; generic type brackets should be escaped.</violation>
</file>
<file name="samples/client/others/kotlin-jvm-okhttp-non-ascii-headers/docs/PetApi.md">
<violation number="1" location="samples/client/others/kotlin-jvm-okhttp-non-ascii-headers/docs/PetApi.md:116">
P3: Unescaped `<Pet>` in the Markdown signature can be parsed as HTML and hide the generic type in rendered docs.</violation>
<violation number="2" location="samples/client/others/kotlin-jvm-okhttp-non-ascii-headers/docs/PetApi.md:164">
P3: Unescaped `<Pet>` in the Markdown signature can be parsed as HTML and hide the generic type in rendered docs.</violation>
</file>
<file name="samples/client/petstore/kotlin-explicit/docs/PetApi.md">
<violation number="1" location="samples/client/petstore/kotlin-explicit/docs/PetApi.md:111">
P3: Raw `<Pet>` in the Markdown signature can be parsed as an HTML tag, which breaks rendering of the generic return type in the generated docs. Restore HTML escaping for the angle brackets.</violation>
</file>
<file name="modules/openapi-generator/src/main/resources/kotlin-server/libraries/javalin5/paramDefault.mustache">
<violation number="1" location="modules/openapi-generator/src/main/resources/kotlin-server/libraries/javalin5/paramDefault.mustache:1">
P2: Duplicate `isUuid` rendering block will emit the UUID default fragment twice, producing invalid Kotlin defaults for UUID parameters.</violation>
</file>
<file name="modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenParameter.java">
<violation number="1" location="modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenParameter.java:37">
P2: `copy()` omits the newly added `unescapedDefaultValue` field, so cloned `CodegenParameter` instances lose this state.</violation>
</file>
<file name="modules/openapi-generator/src/main/resources/kotlin-spring/interfaceOptVar.mustache">
<violation number="1" location="modules/openapi-generator/src/main/resources/kotlin-spring/interfaceOptVar.mustache:2">
P2: `example` values are still emitted unescaped into Kotlin string literals, so examples containing quotes, backslashes, `$`, or newlines can break generated code or cause unintended interpolation.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
Contributor
There was a problem hiding this comment.
1 issue found across 77 files (changes from recent commits).
Note: This PR contains a large number of files. cubic only reviews up to 75 files per PR, so some files may not have been reviewed. cubic prioritises the most important files to review.
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="modules/openapi-generator/src/main/resources/kotlin-client/api_doc.mustache">
<violation number="1" location="modules/openapi-generator/src/main/resources/kotlin-client/api_doc.mustache:30">
P2: Unescaped parameter descriptions inside the fenced code block can break Markdown rendering (e.g., backticks closing the fence).</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
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.
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.
master(upcoming7.x.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)"fixes #123"present in the PR description)Summary by cubic
Fixes Kotlin string and Markdown escaping across generators and docs to prevent string interpolation, bad annotations, and broken Markdown/code blocks. Adds shared lambdas and unescaped fields, and updates Kotlin templates for correct defaults and clean docs.
Bug Fixes
@Path/@Query/@Header/@Field/@Part, Retrofit paths, WireMockurlPathTemplate, Jackson@JsonProperty, etc.).escapeMarkdownto avoid broken tables and premature code block endings.@Operation.summaryuses escaped normal strings;descriptionuses triple-quoted strings with$escaped;@ApiResponse.descriptionuses unescaped message with proper escaping.$handling in path constants and@JsonProperty(new OpenAPI spec).Refactors
unescapedDefaultValue(property/param),unescapedSummary(operation),unescapedMessage(response).escapeInNormalString,escapeDollarInMultiline,escapeMarkdown,removeLineBreak; remove ad‑hoc lambdas inkotlin-spring.okhttp,retrofit2,ktor,spring,volley,vertx,misk,wiremock,jaxrs-spec, andjavalinto use the new lambdas and fields.Written for commit a40fa01. Summary will update on new commits. Review in cubic