Remove modelFilesConstrainedTo from gradle example - #8312
Conversation
|
@feenr thanks for the PR. Is |
|
@wing328 modelFilesConstrainedTo itself is working perfectly fine me. However, my first time using OpenAPIGenerator I copied the example from the readme, being unfamiliar with the settings. This results in a task run that is successful but has absoluately no output. It took some time to realize that modelFilesConstrainedTo was the root cause. I believe ommitting it from the example is a better onboarding experience for new users. As the user's usage of OpenAPI Generater gets more sophisticated they can choose to use modelFilesConstrainedTo to limit the generated output. |
|
I created an issue outlining my reasoning. |
|
@feenr thanks for the explanation and the PR to improve the example. |
Updated the gradle example to exclude the modelFilesConstrainedTo parameter.
I didn't do any testing beyond using this same configuration when trying out the openapi-generator project. The parameter is optional, and ommitting it should not cause any negative behaviors for new users.
PR checklist
./bin/generate-samples.shto update all Petstore samples related to your fix. 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*. For Windows users, please run the script in Git BASH.master,5.1.x,6.0.x