Skip to content

Fix so that the x-field-extra-annotation properly split any array items#22226

Merged
wing328 merged 2 commits intoOpenAPITools:masterfrom
Mattias-Sehlstedt:x-extra-field-annotation
Oct 27, 2025
Merged

Fix so that the x-field-extra-annotation properly split any array items#22226
wing328 merged 2 commits intoOpenAPITools:masterfrom
Mattias-Sehlstedt:x-extra-field-annotation

Conversation

@Mattias-Sehlstedt
Copy link
Copy Markdown
Contributor

Fixes #19953

When defining a list of x-field-extra-annotation annotations as per

"Object": {
  "type": "object",
  "properties": {
    "var": {
      "type": "string",
      "x-field-extra-annotation": [
        "@MyAnnotation",
        "@My2ndAnnotation"
      ]
    },
  },
}

the code currently becomes

...

[@MyAnnotation, @My2ndAnnotation]
[@MyAnnotation, @My2ndAnnotation]
private String var;

...

rather than the expected

...

@MyAnnotation
@My2ndAnnotation
private String var;

...

This is solved by replacing the mustache definition

{{#vendorExtensions.x-field-extra-annotation}}
{{{vendorExtensions.x-field-extra-annotation}}}
{{/vendorExtensions.x-field-extra-annotation}}

with

{{#vendorExtensions.x-field-extra-annotation}}
{{{.}}}
{{/vendorExtensions.x-field-extra-annotation}}

to properly iterate over the unique items in the list.

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.

@wing328 wing328 merged commit 75ae04e into OpenAPITools:master Oct 27, 2025
14 checks passed
@wing328 wing328 added this to the 7.17.0 milestone Nov 6, 2025
rajvesh pushed a commit to rajvesh/openapi-generator that referenced this pull request Dec 25, 2025
…ms (OpenAPITools#22226)

* Fix so that the x-field-extra-annotation properly split any array items

* Add a unit test to show that the annotations are generated as expected
@Mattias-Sehlstedt Mattias-Sehlstedt deleted the x-extra-field-annotation branch January 31, 2026 10:30
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.

[BUG] x-field-extra-annotation for spring generator produces invalid Java source

2 participants