Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migration Guide: add "Validate spec on generation by default" section #683

Merged
merged 2 commits into from
Jul 30, 2018
Merged

Migration Guide: add "Validate spec on generation by default" section #683

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f05ea89
Add "Validate spec on generation by default"
jmini Jul 30, 2018
eae8195
Update migration-guide.adoc
jmini Jul 30, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/migration-guide.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,17 @@ Version `3.2.0` is a minor version of OpenAPI-Generator, in comparison to `3.1.x
The default value of some options might change.
Projects relying on generated code might need to be adapted.

==== Validate spec on generation by default

The default is to validate the spec during generation. If the spec has errors,
they will appear as errors or warnings to the user. This prevent generation of the project.

If you want to switch back to the `3.1.x` behavior you can use:

* Set the `validateSpec` option to `false` if you are using the Maven or Gradle plugin
* Use the command line option `--skip-validate-spec` if you are using the CLI


==== Model (all languages)

In `CodegenModel` and in `CodegenOperation` we use now our own class `org.openapitools.codegen.CodegenDiscriminator` instead of `io.swagger.v3.oas.models.media.Discriminator`.
Expand Down