Skip to content

Conversation

@jimschubert
Copy link
Member

@jimschubert jimschubert commented Apr 1, 2019

PR checklist

  • Read the contribution guidelines.
  • Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in .\bin\windows\.
  • Filed the PR against the correct branch: master, 3.4.x, 4.0.x. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

Description of the PR

Extending on #2429, this adds package name globally in the CLI and Gradle Plugins. We have options for api package, model package, and invoker package globally. Configuring the three of these plus packageName in different locations can be confusing for the generators which support all four options.

There may be concern that packageName is made a "global" option and isn't supported by all generators, but there are quite a few options that aren't supported by many generators (e.g. all package related options, file post processing, etc). This favors usability in these cases.

I've opened #2556 for discussions about options which may or may not belong globally.

CLI supports other package-related options (--api-package,
--model-package, --invoker-package). This aligns those options with
--package-name to avoid confusion about how to configure these options
where those are supported.

This intentionally does not apply a packageName getter/setter to
DefaultCodegen to reduce the footprint of this change.
This makes packageName available as a global option, beside apiPackage,
modelPackage, and invokerPackage to reduce potential confusion about how
to configure the four of these options by generators which support them.
@wing328 wing328 merged commit 5ea4391 into master Apr 30, 2019
@wing328 wing328 deleted the package-name-globally branch April 30, 2019 16:46
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