[go][java] Document new parameterized server support #5380
Conversation
|
👍 Thanks for opening this issue! The team will review the labels and make any necessary changes. |
|
|
||
| featureSet = getFeatureSet().modify() | ||
| .includeDocumentationFeatures(DocumentationFeature.Readme) | ||
| .includeGlobalFeatures(GlobalFeature.ParameterizedServer) |
There was a problem hiding this comment.
AFAICS this was only implemented for Jersey2 client in #4998 - can we mark this feature as included based on the API library used when generating?
There was a problem hiding this comment.
Great call out. I added this here because the ServerConfiguration and ServerVariable types were added to all java generators. I wonder if that was intentional and those files should only be added if Jersey is selected.
I can add this to the libraries option. We're currently not outputting library specific feature matrix.
There was a problem hiding this comment.
IIUC it would be better to only add these files when jersey2 is used, CC @jirikuncar who authored the PR to confirm.
There was a problem hiding this comment.
Yes, the parameterised server per endpoint support is only in jersey2.
There was a problem hiding this comment.
Hm. I'm glad this happened because it made me realize that I screwed up the location of the featureSet property. I'd designed it to be a property on GeneratorMetadata alongside getLibraryFeatures, but for some reason I made the property on GeneratorMetadata and DefaultCodegen.
I'll leave this option where it is now on this PR, add a TODO and move the supportingFiles additions to only occur when jersey is selected… then I'll open another PR to move featureSets to generatorMetadata and include the library-specific option in that PR.
There was a problem hiding this comment.
There is a support for global server URL generation in all Java clients, that can be used instead of basePath. Additionally Jersey2 has support for server URL configuration per endpoint.
There was a problem hiding this comment.
I was not clear. There are actually 2 features to track:
- Support for global server configuration with templated values (all Java)
- Support for server configuration per endpoint (only jersey2, go-experimental)
There was a problem hiding this comment.
So, we probably need a GlobalFeature.ParameterizedServerPerOperation?
There was a problem hiding this comment.
I created #5402 to track adding another feature for per-operation server variables.
| writeOptional(outputFolder, new SupportingFile("manifest.mustache", projectFolder, "AndroidManifest.xml")); | ||
| supportingFiles.add(new SupportingFile("travis.mustache", "", ".travis.yml")); | ||
| supportingFiles.add(new SupportingFile("ApiClient.mustache", invokerFolder, "ApiClient.java")); | ||
| supportingFiles.add(new SupportingFile("ServerConfiguration.mustache", invokerFolder, "ServerConfiguration.java")); |
There was a problem hiding this comment.
see https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/resources/Java/ApiClient.mustache#L68-L94 and https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/resources/Java/ApiClient.mustache#L684-L695
There was a problem hiding this comment.
I see. I could have sworn it was for all clients when I reviewed your other PR and didn't see how it was jersey2-only. I regenerated samples against this commit and pushed to check compilation, but I'll make this change and push over that.
...es/openapi-generator/src/main/java/org/openapitools/codegen/languages/JavaClientCodegen.java
Outdated
Show resolved
Hide resolved
...es/openapi-generator/src/main/java/org/openapitools/codegen/languages/JavaClientCodegen.java
Outdated
Show resolved
Hide resolved
...es/openapi-generator/src/main/java/org/openapitools/codegen/languages/JavaClientCodegen.java
Outdated
Show resolved
Hide resolved
...es/openapi-generator/src/main/java/org/openapitools/codegen/languages/JavaClientCodegen.java
Outdated
Show resolved
Hide resolved
jimschubert
force-pushed
the
java-server-variable-support-meta
branch
from
d103918 to
1b45e49
Compare
* [go][java] Document new parameterized server support * [java] Regenerate samples
Support for parameterized server was added to java in #4998 and go in #4635. This flags the metadata as supported so it will display on our generator docs pages.
See also #590
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.shif 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.FYI:
Java Technical Committee
@bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10) @bkabrda (2020/01)
Go Technical Committee
@antihax (2017/11) @bvwells (2017/12) @grokify (2018/07) @kemokemo (2018/09) @bkabrda (2019/07)