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.

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

[discussion] Consider reducing amount of global options #2556

Open
jimschubert opened this issue Apr 1, 2019 · 7 comments
Open

[discussion] Consider reducing amount of global options #2556

jimschubert opened this issue Apr 1, 2019 · 7 comments
Assignees

Comments

@jimschubert
Copy link
Member

Description

A question was raised out of #2429. We have quite a few "global" options (those available across all generators), which either aren't relevant to or aren't supported by many generators.

Should we consider thinning out these global options, or more clearly identifier which options are supported by which generators?

Per #2429, we should also identify if there may be other options which exist in global options with sibling options only available in additionalProperties.

openapi-generator version

Pre-4.0

cc @OpenAPITools/generator-core-team

@auto-labeler
Copy link

auto-labeler bot commented Apr 1, 2019

👍 Thanks for opening this issue!
🏷 I have applied any labels matching special text in your issue.

The team will review the labels and make any necessary changes.

@cbornet
Copy link
Member

cbornet commented Apr 1, 2019

+1

@wing328
Copy link
Member

wing328 commented Apr 1, 2019

What about doing it one step further by completely eliminating global options and having generator's options only? Likely this will be less confusing to new users.

(we do not allow multiple "generator" (-g) target so the global option is not that useful as it cannot be shared)

@jimschubert
Copy link
Member Author

I like that idea as well. I wonder if it might be possible to pass those options as if they're global options rather than additionalProperties and configOptions.

@jimschubert
Copy link
Member Author

Somewhat related to "Global Options", the CLI generate command has an argument -D, which looks like it should be setting Java system properties to users (see #2706). I've deprecated that -D argument as part of #2946. While working on that PR, I considered what it might look like to remove the "global" options, and I think this pose some hurdles in the externalize configuration file.

@jimschubert
Copy link
Member Author

Let's try to clean this up one way or another for 5.1.

@jimschubert
Copy link
Member Author

I think we'll need to deprecate all the top-level properties in CLI and plugins for 5.0 and through at least 5.1.0

@jimschubert jimschubert self-assigned this Oct 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants