-
-
Notifications
You must be signed in to change notification settings - Fork 6.7k
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.
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
[maven] Docs and minor refactoring #5251
Merged
jimschubert
merged 1 commit into
OpenAPITools:master
from
jimschubert:improve-maven-plugin-doc
Feb 9, 2020
Merged
[maven] Docs and minor refactoring #5251
jimschubert
merged 1 commit into
OpenAPITools:master
from
jimschubert:improve-maven-plugin-doc
Feb 9, 2020
Conversation
This file contains 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
The maven documentation was missing a few option, a couple of option properties, and was inconsistent regarding selective generation for apis an models. This adds properties and options where appropriate and updates the docs. All options in the README have been reordered to match property declaration order in CodegenMojo, hopefully making it easier for maintainers to recognized when there are docs missing or out of date. This also slightly refactors the code in CodegenMojo to reduce the cyclomatic complexity of the `execute` method.
👍 Thanks for opening this issue! The team will review the labels and make any necessary changes. |
shybovycha
reviewed
Feb 9, 2020
@@ -603,7 +611,7 @@ public void execute() throws MojoExecutionException { | |||
|
|||
// Set generation options | |||
if (null != generateApis && generateApis) { | |||
GlobalSettings.setProperty(CodegenConstants.APIS, ""); | |||
GlobalSettings.setProperty(CodegenConstants.APIS, apisToGenerate); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
absolutely love it!
MikailBag
pushed a commit
to MikailBag/openapi-generator
that referenced
this pull request
Mar 23, 2020
The maven documentation was missing a few option, a couple of option properties, and was inconsistent regarding selective generation for apis an models. This adds properties and options where appropriate and updates the docs. All options in the README have been reordered to match property declaration order in CodegenMojo, hopefully making it easier for maintainers to recognized when there are docs missing or out of date. This also slightly refactors the code in CodegenMojo to reduce the cyclomatic complexity of the `execute` method.
wing328
changed the title
[maven]:memo: Docs and minor refactoring
[maven] Docs and minor refactoring
Mar 26, 2020
wing328
changed the title
[maven] Docs and minor refactoring
[maven] :memo Docs and minor refactoring
Mar 26, 2020
wing328
changed the title
[maven] :memo Docs and minor refactoring
[maven] Docs and minor refactoring
Mar 26, 2020
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.
The maven documentation was missing a few option, a couple of option
properties, and was inconsistent regarding selective generation for apis
an models. This adds properties and options where appropriate and
updates the docs. All options in the README have been reordered to match
property declaration order in CodegenMojo, hopefully making it easier
for maintainers to recognized when there are docs missing or out of
date.
This also slightly refactors the code in CodegenMojo to reduce the
cyclomatic complexity of the
execute
method.PR checklist
./bin/
(or Windows batch scripts under.\bin\windows
) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run./bin/{LANG}-petstore.sh
,./bin/openapi3/{LANG}-petstore.sh
if updating the code or mustache templates for a language ({LANG}
) (e.g. php, ruby, python, etc).master
,4.3.x
,5.0.x
. Default:master
.cc @OpenAPITools/generator-core-team @shybovycha
closes #4938
closes #4937
@shybovycha I hope this documentation update helps make it more clear how to use these properties without potential breaking changes and without using
additionalProperties
as a fallback as you've proposed in your PR.