Skip to content

[go] Fix text escaping in example code generation#22841

Merged
wing328 merged 1 commit intoOpenAPITools:masterfrom
roidelapluie:fix-go-example-escaping
Jan 30, 2026
Merged

[go] Fix text escaping in example code generation#22841
wing328 merged 1 commit intoOpenAPITools:masterfrom
roidelapluie:fix-go-example-escaping

Conversation

@roidelapluie
Copy link
Contributor

@roidelapluie roidelapluie commented Jan 28, 2026

Wrap example values with escapeText() to properly escape special characters in generated Go client code examples

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 || 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.
  • 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)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • 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

Fixes string escaping in generated Go client examples to prevent compilation errors when example values contain special characters. Example strings (including emails) are now passed through escapeText().

  • Bug Fixes
    • Escape string and email example values for parameters and properties using escapeText().
    • Prevent invalid Go code when examples include quotes, backslashes, or other special characters.

Written for commit 9172ce8. Summary will update on new commits.

Copy link
Contributor

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

Choose a reason for hiding this comment

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

No issues found across 1 file

@wing328
Copy link
Member

wing328 commented Jan 28, 2026

cc @antihax (2017/11) @grokify (2018/07) @kemokemo (2018/09) @jirikuncar (2021/01) @ph4r5h4d (2021/04) @lwj5 (2023/04)

@wing328
Copy link
Member

wing328 commented Jan 28, 2026

thanks for the PR

may i know if you've a minimal spec to reproduce the issue so that we can use to more easily confirm the fix?

Wrap example values with escapeText() to properly escape special
characters in generated Go client code examples

Signed-off-by: Julien Pivotto <291750+roidelapluie@users.noreply.github.com>
@roidelapluie roidelapluie force-pushed the fix-go-example-escaping branch from 1918496 to 9172ce8 Compare January 29, 2026 11:33
@wing328
Copy link
Member

wing328 commented Jan 30, 2026

did a test locally and the change looks good

@wing328 wing328 merged commit 82ad061 into OpenAPITools:master Jan 30, 2026
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants