Skip to content

Postman Generator: Format json edge case#23265

Merged
wing328 merged 1 commit intoOpenAPITools:masterfrom
gcatanese:tag-description-control-chars-escaping
Mar 16, 2026
Merged

Postman Generator: Format json edge case#23265
wing328 merged 1 commit intoOpenAPITools:masterfrom
gcatanese:tag-description-control-chars-escaping

Conversation

@gcatanese
Copy link
Copy Markdown
Contributor

@gcatanese gcatanese commented Mar 16, 2026

Address edge case (JSON formatting) - cubic-dev comment

@wing328

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

Ensures tag names and descriptions in the postman-collection generator are properly JSON-escaped, including control characters, to prevent invalid Postman JSON and broken imports.

  • Bug Fixes
    • Escape control characters in tag names/descriptions using JsonStringEncoder in PostmanCollectionCodegen.
    • Added test and sample spec to verify escaping for \t, \b, \f, \r, and \n.

Written for commit 7f0ba9c. Summary will update on new commits.

Copy link
Copy Markdown
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 3 files

@wing328 wing328 merged commit e444bf9 into OpenAPITools:master Mar 16, 2026
15 checks passed
@wing328 wing328 added this to the 7.21.0 milestone Mar 21, 2026
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.

2 participants