Skip to content

Remove modelFilesConstrainedTo from gradle example - #8312

Merged
jimschubert merged 1 commit into
OpenAPITools:masterfrom
feenr:issues/8311
Jan 10, 2021
Merged

Remove modelFilesConstrainedTo from gradle example#8312
jimschubert merged 1 commit into
OpenAPITools:masterfrom
feenr:issues/8311

Conversation

@feenr

@feenr feenr commented Jan 3, 2021

Copy link
Copy Markdown
Contributor

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

  • 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.
  • If contributing template-only or documentation-only changes which will change sample output, build the project beforehand.
  • Run the shell script ./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.
  • File the PR against the correct branch: master, 5.1.x, 6.0.x
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

@feenr
feenr requested a review from jimschubert as a code owner January 3, 2021 18:26
@wing328

wing328 commented Jan 7, 2021

Copy link
Copy Markdown
Member

@feenr thanks for the PR. Is modelFilesConstrainedTo causing any issues to you?

@feenr

feenr commented Jan 7, 2021

Copy link
Copy Markdown
Contributor Author

@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.

@feenr

feenr commented Jan 7, 2021

Copy link
Copy Markdown
Contributor Author

I created an issue outlining my reasoning.
#8311

@jimschubert
jimschubert merged commit e26f440 into OpenAPITools:master Jan 10, 2021
@wing328

wing328 commented Jan 11, 2021

Copy link
Copy Markdown
Member

@feenr thanks for the explanation and the PR to improve the example.

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.

3 participants