[req] Allow models and apis list properties to span multi-lines#21536
Merged
wing328 merged 3 commits intoOpenAPITools:masterfrom Jul 10, 2025
Merged
[req] Allow models and apis list properties to span multi-lines#21536wing328 merged 3 commits intoOpenAPITools:masterfrom
wing328 merged 3 commits intoOpenAPITools:masterfrom
Conversation
…nclude white space (OpenAPITools#19628)
wing328
reviewed
Jul 9, 2025
modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultGenerator.java
Show resolved
Hide resolved
Member
|
when you've time, can you please rebase this change with the latest master? thank you |
fba55b9 to
cdebf4d
Compare
Contributor
Author
|
Rebased and fixed a couple of variable names in the unit test. |
Member
|
thanks for the contribution. let's give it a try |
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.
fix Issue 19628
For consideration, this code change to
DefaultGenerator.javaallows API, MODELS, SUPPORTED_FILES & WEBHOOKS properties to include white space and newlines which are trimmed after splitting. This allows users to specify longer lists of models using maven without having to worry about extra spaces or newlines.I opted to change
DefaultGeneratorinstead of modifying theCodeGenMojoin the maven plugin since MODELS or APIS can be specified in either inmodelsToGenerateor in theglobalProperties/modelssetting. Doing so in DefaultGenerator allows for either method to span multi-lines. See the maven plugin README for an example of specifying MODELS viaglobalPropertiesormodelsToGenerate.I've added a unit test in
DefaultGeneratorTestthat should cover all the properties except forWEBHOOKS. If there are some modifications I can make to the unit test to support multipleWEBHOOKSin the OpenAPI spec, let me know and I can add them.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)