Skip to content

Conversation

@booxter
Copy link
Contributor

@booxter booxter commented Sep 23, 2025

Previous mustache template was using #isBodyParam outside of #operation
context, so it was not effective.

Even if we'd add the proper context, we'd then risk generating duplicate
imports for multiple matching parameters.

For this reason, this patch implements detection of an optional body
parameter in code, making sure the corresponding import is added just
once.

Fixes #19237

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.

Previous mustache template was using #isBodyParam outside of #operation
context, so it was not effective.

Even if we'd add the proper context, we'd then risk generating duplicate
imports for multiple matching parameters.

For this reason, this patch implements detection of an optional body
parameter in code, making sure the corresponding import is added just
once.

Fixes OpenAPITools#19237
@booxter booxter marked this pull request as ready for review September 23, 2025 19:13
@booxter booxter marked this pull request as draft September 23, 2025 19:13
@booxter
Copy link
Contributor Author

booxter commented Sep 24, 2025

@booxter booxter marked this pull request as ready for review September 24, 2025 13:12
@wing328
Copy link
Member

wing328 commented Sep 27, 2025

tested the fix locally and the result is good

thanks for the contribution.

@wing328 wing328 merged commit d8d9744 into OpenAPITools:master Sep 27, 2025
14 checks passed
@wing328 wing328 added this to the 7.16.0 milestone Sep 27, 2025
@wing328
Copy link
Member

wing328 commented Sep 27, 2025

FYI. Merged #22034 to add a test covering this issue moving forward

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.

[BUG] [go-server][golang] Trivial API file causes the generated code not to compile, due to missing imports "io" and "errors"

2 participants