Skip to content
New issue

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

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

Already on GitHub? # to your account

[online] Honor generator environment variable and system property #3265

Merged
merged 1 commit into from
Jul 2, 2019

Conversation

jimschubert
Copy link
Member

@jimschubert jimschubert commented Jul 2, 2019

Previously, this pulled from the GENERATOR_HOST system property. This
should have been an environment variable. Fallback is now generator.host
system property.

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\. If contributing template-only or documentation-only changes which will change sample output, be sure to build the project first.
  • Filed the PR against the correct branch: master, 4.1.x, 5.0.x. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

Previously, this pulled from the GENERATOR_HOST system property. This
should have been an environment variable. Fallback is now generator.host
system property.
@auto-labeler
Copy link

auto-labeler bot commented Jul 2, 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.

@jimschubert
Copy link
Member Author

I realized during testing that I targeted the environment variable via System.getProperty rather than System.getenv. The PR honors both.

@jimschubert jimschubert merged commit 1fc7740 into master Jul 2, 2019
@jimschubert jimschubert deleted the online-generator-env-property branch July 2, 2019 17:07
@cbornet
Copy link
Member

cbornet commented Jul 3, 2019

Springfox already has a springfox.documentation.swagger.v2.host to do that.
Otherwise it can detect the hostname from the request (respecting the x-forwarding-* headers) so forcing it to localhost by default is not correct.

@jimschubert
Copy link
Member Author

@cbornet I'll look at passing this to springfox.documentation.swagger.v2.host in the Dockerfile and on the server, and removing generator.host as an available property.

We'll probably want to keep GENERATOR_HOST to avoid hardcoded *.swagger.v2.* property which will most likely change in a newer springfox.

@wing328 wing328 added this to the 4.1.0 milestone Aug 9, 2019
# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants