Skip to content

[go][java] Document new parameterized server support#5380

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.

Sign up for GitHub

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

Merged
jimschubert merged 5 commits into from
Feb 23, 2020
Merged

[go][java] Document new parameterized server support #5380

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
83eeeea
[go][java] Document new parameterized server support
jimschubert Feb 20, 2020
89af9cf
[java] Move parameterized server support to jersey2
jimschubert Feb 21, 2020
bf12323
[java] Regenerate samples
jimschubert Feb 21, 2020
1b45e49
[java] Include "global" server configuration for all java clients
jimschubert Feb 21, 2020
a6f98bc
[java] Add back ServerVariable for java clients
jimschubert Feb 22, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/generators/go-experimental.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -162,7 +162,7 @@ sidebar_label: go-experimental
|Examples|✓|OAS2,OAS3
|XMLStructureDefinitions|✗|OAS2,OAS3
|MultiServer|✗|OAS3
|ParameterizedServer|✗|OAS3
|ParameterizedServer|✓|OAS3
|ParameterStyling|✗|OAS3
|Callbacks|✗|OAS3
|LinkObjects|✗|OAS3
Expand Down
2 changes: 1 addition & 1 deletion docs/generators/go.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -162,7 +162,7 @@ sidebar_label: go
|Examples|✓|OAS2,OAS3
|XMLStructureDefinitions|✗|OAS2,OAS3
|MultiServer|✗|OAS3
|ParameterizedServer|✗|OAS3
|ParameterizedServer|✓|OAS3
|ParameterStyling|✗|OAS3
|Callbacks|✗|OAS3
|LinkObjects|✗|OAS3
Expand Down
2 changes: 1 addition & 1 deletion docs/generators/java.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -241,7 +241,7 @@ sidebar_label: java
|Examples|✓|OAS2,OAS3
|XMLStructureDefinitions|✗|OAS2,OAS3
|MultiServer|✗|OAS3
|ParameterizedServer|✗|OAS3
|ParameterizedServer|✓|OAS3
|ParameterStyling|✗|OAS3
|Callbacks|✗|OAS3
|LinkObjects|✗|OAS3
Expand Down
3 changes: 3 additions & 0 deletions ...s/openapi-generator/src/main/java/org/openapitools/codegen/languages/GoClientCodegen.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -52,6 +52,9 @@ public GoClientCodegen() {
SecurityFeature.ApiKey,
SecurityFeature.OAuth2_Implicit
))
.includeGlobalFeatures(
GlobalFeature.ParameterizedServer
)
.excludeGlobalFeatures(
GlobalFeature.XMLStructureDefinitions,
GlobalFeature.Callbacks,
Expand Down
4 changes: 4 additions & 0 deletions ...openapi-generator/src/main/java/org/openapitools/codegen/languages/JavaClientCodegen.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,7 @@
import org.openapitools.codegen.languages.features.GzipFeatures;
import org.openapitools.codegen.languages.features.PerformBeanValidationFeatures;
import org.openapitools.codegen.meta.features.DocumentationFeature;
import org.openapitools.codegen.meta.features.GlobalFeature;
import org.openapitools.codegen.templating.mustache.CaseFormatLambda;
import org.openapitools.codegen.utils.ProcessUtils;
import org.slf4j.Logger;
Expand DownExpand Up@@ -106,8 +107,10 @@ public class JavaClientCodegen extends AbstractJavaCodegen
public JavaClientCodegen() {
super();

// TODO: Move GlobalFeature.ParameterizedServer to library: jersey after moving featureSet to generatorMetadata
featureSet = getFeatureSet().modify()
.includeDocumentationFeatures(DocumentationFeature.Readme)
.includeGlobalFeatures(GlobalFeature.ParameterizedServer)

@bkabrdabkabrdaFeb 20, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

@jimschubertjimschubertFeb 20, 2020•
edited
Loading

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@bkabrdabkabrdaFeb 20, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IIUC it would be better to only add these files when jersey2 is used, CC @jirikuncar who authored the PR to confirm.

@jirikuncarjirikuncarFeb 20, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, the parameterised server per endpoint support is only in jersey2.

@jimschubertjimschubertFeb 21, 2020

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 GeneratorMetadataandDefaultCodegen.

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.

@jirikuncarjirikuncarFeb 21, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@jirikuncarjirikuncarFeb 21, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was not clear. There are actually 2 features to track:

  1. Support for global server configuration with templated values (all Java)
  2. Support for server configuration per endpoint (only jersey2, go-experimental)

@jimschubertjimschubertFeb 22, 2020

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So, we probably need a GlobalFeature.ParameterizedServerPerOperation?

@jimschubertjimschubertFeb 22, 2020

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I created #5402 to track adding another feature for per-operation server variables.

.build();

outputFolder = "generated-code" + File.separator + "java";
Expand DownExpand Up@@ -290,6 +293,7 @@ public void processOpts() {
supportingFiles.add(new SupportingFile("ApiClient.mustache", invokerFolder, "ApiClient.java"));
supportingFiles.add(new SupportingFile("ServerConfiguration.mustache", invokerFolder, "ServerConfiguration.java"));

@jirikuncarjirikuncarFeb 21, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should stay here

@jirikuncarjirikuncarFeb 21, 2020•
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@jimschubertjimschubertFeb 21, 2020

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

supportingFiles.add(new SupportingFile("ServerVariable.mustache", invokerFolder, "ServerVariable.java"));

if (!(RESTTEMPLATE.equals(getLibrary()) || REST_ASSURED.equals(getLibrary()) || NATIVE.equals(getLibrary()) || MICROPROFILE.equals(getLibrary()))) {
supportingFiles.add(new SupportingFile("StringUtil.mustache", invokerFolder, "StringUtil.java"));
}
Expand Down
4 changes: 4 additions & 0 deletions .../openapi-generator/src/test/java/org/openapitools/codegen/java/JavaClientCodegenTest.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -290,6 +290,8 @@ public void testGeneratePing() throws Exception {
TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/ApiClient.java");
TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/ApiException.java");
TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/ApiResponse.java");
TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/ServerConfiguration.java");
TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/ServerVariable.java");
TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/auth/ApiKeyAuth.java");
TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/auth/Authentication.java");
TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/auth/HttpBasicAuth.java");
Expand DownExpand Up@@ -364,6 +366,8 @@ public void testGeneratePingSomeObj() throws Exception {
TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/ApiClient.java");
TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/ApiException.java");
TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/ApiResponse.java");
TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/ServerConfiguration.java");
TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/ServerVariable.java");
TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/auth/ApiKeyAuth.java");
TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/auth/Authentication.java");
TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/auth/HttpBasicAuth.java");
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
[go][java] Document new parameterized server support by jimschubert · Pull Request #5380 · OpenAPITools/openapi-generator · GitHub
Skip to content
[go][java] Document new parameterized server support#5380

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.

 Sign up for GitHub

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

 Merged

jimschubert
merged 5 commits into

from

Feb 23, 2020
 Merged


[go][java] Document new parameterized server support
#5380
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
83eeeea

[go][java] Document new parameterized server support


jimschubert Feb 20, 2020
89af9cf

[java] Move parameterized server support to jersey2


jimschubert Feb 21, 2020
bf12323

[java] Regenerate samples


jimschubert Feb 21, 2020
1b45e49

[java] Include "global" server configuration for all java clients


jimschubert Feb 21, 2020
a6f98bc

[java] Add back ServerVariable for java clients


jimschubert Feb 22, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
docs/generators/go-experimental.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -162,7 +162,7 @@ sidebar_label: go-experimental
|Examples|✓|OAS2,OAS3
|XMLStructureDefinitions|✗|OAS2,OAS3
|MultiServer|✗|OAS3
|ParameterizedServer|✗|OAS3
|ParameterizedServer|✓|OAS3
|ParameterStyling|✗|OAS3
|Callbacks|✗|OAS3
|LinkObjects|✗|OAS3
Expand Down

2 changes: 1 addition & 1 deletion
docs/generators/go.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -162,7 +162,7 @@ sidebar_label: go
|Examples|✓|OAS2,OAS3
|XMLStructureDefinitions|✗|OAS2,OAS3
|MultiServer|✗|OAS3
|ParameterizedServer|✗|OAS3
|ParameterizedServer|✓|OAS3
|ParameterStyling|✗|OAS3
|Callbacks|✗|OAS3
|LinkObjects|✗|OAS3
Expand Down

2 changes: 1 addition & 1 deletion
docs/generators/java.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -241,7 +241,7 @@ sidebar_label: java
|Examples|✓|OAS2,OAS3
|XMLStructureDefinitions|✗|OAS2,OAS3
|MultiServer|✗|OAS3
|ParameterizedServer|✗|OAS3
|ParameterizedServer|✓|OAS3
|ParameterStyling|✗|OAS3
|Callbacks|✗|OAS3
|LinkObjects|✗|OAS3
Expand Down

3 changes: 3 additions & 0 deletions
...s/openapi-generator/src/main/java/org/openapitools/codegen/languages/GoClientCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,6 +52,9 @@ public GoClientCodegen() {
 SecurityFeature.ApiKey,
 SecurityFeature.OAuth2_Implicit
 ))
 .includeGlobalFeatures(
 GlobalFeature.ParameterizedServer
 )
 .excludeGlobalFeatures(
 GlobalFeature.XMLStructureDefinitions,
 GlobalFeature.Callbacks,
Expand Down

4 changes: 4 additions & 0 deletions
...openapi-generator/src/main/java/org/openapitools/codegen/languages/JavaClientCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,7 @@
import org.openapitools.codegen.languages.features.GzipFeatures;
import org.openapitools.codegen.languages.features.PerformBeanValidationFeatures;
import org.openapitools.codegen.meta.features.DocumentationFeature;
import org.openapitools.codegen.meta.features.GlobalFeature;
import org.openapitools.codegen.templating.mustache.CaseFormatLambda;
import org.openapitools.codegen.utils.ProcessUtils;
import org.slf4j.Logger;
Expand DownExpand Up@@ -106,8 +107,10 @@ public class JavaClientCodegen extends AbstractJavaCodegen
 public JavaClientCodegen() {
 super();

 // TODO: Move GlobalFeature.ParameterizedServer to library: jersey after moving featureSet to generatorMetadata
 featureSet = getFeatureSet().modify()
 .includeDocumentationFeatures(DocumentationFeature.Readme)
 .includeGlobalFeatures(GlobalFeature.ParameterizedServer)
@bkabrdabkabrdaFeb 20, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?
@jimschubertjimschubertFeb 20, 2020•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
@bkabrdabkabrdaFeb 20, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IIUC it would be better to only add these files when jersey2 is used, CC @jirikuncar who authored the PR to confirm.
@jirikuncarjirikuncarFeb 20, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, the parameterised server per endpoint support is only in jersey2.
@jimschubertjimschubertFeb 21, 2020

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 GeneratorMetadataandDefaultCodegen.
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.
@jirikuncarjirikuncarFeb 21, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
@jirikuncarjirikuncarFeb 21, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was not clear. There are actually 2 features to track:
  1. Support for global server configuration with templated values (all Java)
  2. Support for server configuration per endpoint (only jersey2, go-experimental)
@jimschubertjimschubertFeb 22, 2020

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So, we probably need a GlobalFeature.ParameterizedServerPerOperation?
@jimschubertjimschubertFeb 22, 2020

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I created #5402 to track adding another feature for per-operation server variables.
 .build();

 outputFolder = "generated-code" + File.separator + "java";
Expand DownExpand Up@@ -290,6 +293,7 @@ public void processOpts() {
 supportingFiles.add(new SupportingFile("ApiClient.mustache", invokerFolder, "ApiClient.java"));
 supportingFiles.add(new SupportingFile("ServerConfiguration.mustache", invokerFolder, "ServerConfiguration.java"));
@jirikuncarjirikuncarFeb 21, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should stay here
@jirikuncarjirikuncarFeb 21, 2020•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
@jimschubertjimschubertFeb 21, 2020

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
 supportingFiles.add(new SupportingFile("ServerVariable.mustache", invokerFolder, "ServerVariable.java"));

 if (!(RESTTEMPLATE.equals(getLibrary()) || REST_ASSURED.equals(getLibrary()) || NATIVE.equals(getLibrary()) || MICROPROFILE.equals(getLibrary()))) {
 supportingFiles.add(new SupportingFile("StringUtil.mustache", invokerFolder, "StringUtil.java"));
 }
Expand Down

4 changes: 4 additions & 0 deletions
.../openapi-generator/src/test/java/org/openapitools/codegen/java/JavaClientCodegenTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -290,6 +290,8 @@ public void testGeneratePing() throws Exception {
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/ApiClient.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/ApiException.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/ApiResponse.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/ServerConfiguration.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/ServerVariable.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/auth/ApiKeyAuth.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/auth/Authentication.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/auth/HttpBasicAuth.java");
Expand DownExpand Up@@ -364,6 +366,8 @@ public void testGeneratePingSomeObj() throws Exception {
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/ApiClient.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/ApiException.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/ApiResponse.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/ServerConfiguration.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/ServerVariable.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/auth/ApiKeyAuth.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/auth/Authentication.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/auth/HttpBasicAuth.java");
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[go][java] Document new parameterized server support by jimschubert · Pull Request #5380 · OpenAPITools/openapi-generator · GitHub
Skip to content
[go][java] Document new parameterized server support#5380

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.

 Sign up for GitHub

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

 Merged

jimschubert
merged 5 commits into

from

Feb 23, 2020
 Merged


[go][java] Document new parameterized server support
#5380
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
83eeeea

[go][java] Document new parameterized server support


jimschubert Feb 20, 2020
89af9cf

[java] Move parameterized server support to jersey2


jimschubert Feb 21, 2020
bf12323

[java] Regenerate samples


jimschubert Feb 21, 2020
1b45e49

[java] Include "global" server configuration for all java clients


jimschubert Feb 21, 2020
a6f98bc

[java] Add back ServerVariable for java clients


jimschubert Feb 22, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
docs/generators/go-experimental.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -162,7 +162,7 @@ sidebar_label: go-experimental
|Examples|✓|OAS2,OAS3
|XMLStructureDefinitions|✗|OAS2,OAS3
|MultiServer|✗|OAS3
|ParameterizedServer|✗|OAS3
|ParameterizedServer|✓|OAS3
|ParameterStyling|✗|OAS3
|Callbacks|✗|OAS3
|LinkObjects|✗|OAS3
Expand Down

2 changes: 1 addition & 1 deletion
docs/generators/go.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -162,7 +162,7 @@ sidebar_label: go
|Examples|✓|OAS2,OAS3
|XMLStructureDefinitions|✗|OAS2,OAS3
|MultiServer|✗|OAS3
|ParameterizedServer|✗|OAS3
|ParameterizedServer|✓|OAS3
|ParameterStyling|✗|OAS3
|Callbacks|✗|OAS3
|LinkObjects|✗|OAS3
Expand Down

2 changes: 1 addition & 1 deletion
docs/generators/java.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -241,7 +241,7 @@ sidebar_label: java
|Examples|✓|OAS2,OAS3
|XMLStructureDefinitions|✗|OAS2,OAS3
|MultiServer|✗|OAS3
|ParameterizedServer|✗|OAS3
|ParameterizedServer|✓|OAS3
|ParameterStyling|✗|OAS3
|Callbacks|✗|OAS3
|LinkObjects|✗|OAS3
Expand Down

3 changes: 3 additions & 0 deletions
...s/openapi-generator/src/main/java/org/openapitools/codegen/languages/GoClientCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,6 +52,9 @@ public GoClientCodegen() {
 SecurityFeature.ApiKey,
 SecurityFeature.OAuth2_Implicit
 ))
 .includeGlobalFeatures(
 GlobalFeature.ParameterizedServer
 )
 .excludeGlobalFeatures(
 GlobalFeature.XMLStructureDefinitions,
 GlobalFeature.Callbacks,
Expand Down

4 changes: 4 additions & 0 deletions
...openapi-generator/src/main/java/org/openapitools/codegen/languages/JavaClientCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,7 @@
import org.openapitools.codegen.languages.features.GzipFeatures;
import org.openapitools.codegen.languages.features.PerformBeanValidationFeatures;
import org.openapitools.codegen.meta.features.DocumentationFeature;
import org.openapitools.codegen.meta.features.GlobalFeature;
import org.openapitools.codegen.templating.mustache.CaseFormatLambda;
import org.openapitools.codegen.utils.ProcessUtils;
import org.slf4j.Logger;
Expand DownExpand Up@@ -106,8 +107,10 @@ public class JavaClientCodegen extends AbstractJavaCodegen
 public JavaClientCodegen() {
 super();

 // TODO: Move GlobalFeature.ParameterizedServer to library: jersey after moving featureSet to generatorMetadata
 featureSet = getFeatureSet().modify()
 .includeDocumentationFeatures(DocumentationFeature.Readme)
 .includeGlobalFeatures(GlobalFeature.ParameterizedServer)
@bkabrdabkabrdaFeb 20, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?
@jimschubertjimschubertFeb 20, 2020•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
@bkabrdabkabrdaFeb 20, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IIUC it would be better to only add these files when jersey2 is used, CC @jirikuncar who authored the PR to confirm.
@jirikuncarjirikuncarFeb 20, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, the parameterised server per endpoint support is only in jersey2.
@jimschubertjimschubertFeb 21, 2020

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 GeneratorMetadataandDefaultCodegen.
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.
@jirikuncarjirikuncarFeb 21, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
@jirikuncarjirikuncarFeb 21, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was not clear. There are actually 2 features to track:
  1. Support for global server configuration with templated values (all Java)
  2. Support for server configuration per endpoint (only jersey2, go-experimental)
@jimschubertjimschubertFeb 22, 2020

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So, we probably need a GlobalFeature.ParameterizedServerPerOperation?
@jimschubertjimschubertFeb 22, 2020

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I created #5402 to track adding another feature for per-operation server variables.
 .build();

 outputFolder = "generated-code" + File.separator + "java";
Expand DownExpand Up@@ -290,6 +293,7 @@ public void processOpts() {
 supportingFiles.add(new SupportingFile("ApiClient.mustache", invokerFolder, "ApiClient.java"));
 supportingFiles.add(new SupportingFile("ServerConfiguration.mustache", invokerFolder, "ServerConfiguration.java"));
@jirikuncarjirikuncarFeb 21, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should stay here
@jirikuncarjirikuncarFeb 21, 2020•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
@jimschubertjimschubertFeb 21, 2020

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
 supportingFiles.add(new SupportingFile("ServerVariable.mustache", invokerFolder, "ServerVariable.java"));

 if (!(RESTTEMPLATE.equals(getLibrary()) || REST_ASSURED.equals(getLibrary()) || NATIVE.equals(getLibrary()) || MICROPROFILE.equals(getLibrary()))) {
 supportingFiles.add(new SupportingFile("StringUtil.mustache", invokerFolder, "StringUtil.java"));
 }
Expand Down

4 changes: 4 additions & 0 deletions
.../openapi-generator/src/test/java/org/openapitools/codegen/java/JavaClientCodegenTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -290,6 +290,8 @@ public void testGeneratePing() throws Exception {
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/ApiClient.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/ApiException.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/ApiResponse.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/ServerConfiguration.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/ServerVariable.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/auth/ApiKeyAuth.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/auth/Authentication.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/auth/HttpBasicAuth.java");
Expand DownExpand Up@@ -364,6 +366,8 @@ public void testGeneratePingSomeObj() throws Exception {
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/ApiClient.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/ApiException.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/ApiResponse.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/ServerConfiguration.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/ServerVariable.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/auth/ApiKeyAuth.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/auth/Authentication.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/auth/HttpBasicAuth.java");
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[go][java] Document new parameterized server support by jimschubert · Pull Request #5380 · OpenAPITools/openapi-generator · GitHub
Skip to content
[go][java] Document new parameterized server support#5380

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.

 Sign up for GitHub

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

 Merged

jimschubert
merged 5 commits into

from

Feb 23, 2020
 Merged


[go][java] Document new parameterized server support
#5380
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
83eeeea

[go][java] Document new parameterized server support


jimschubert Feb 20, 2020
89af9cf

[java] Move parameterized server support to jersey2


jimschubert Feb 21, 2020
bf12323

[java] Regenerate samples


jimschubert Feb 21, 2020
1b45e49

[java] Include "global" server configuration for all java clients


jimschubert Feb 21, 2020
a6f98bc

[java] Add back ServerVariable for java clients


jimschubert Feb 22, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
docs/generators/go-experimental.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -162,7 +162,7 @@ sidebar_label: go-experimental
|Examples|✓|OAS2,OAS3
|XMLStructureDefinitions|✗|OAS2,OAS3
|MultiServer|✗|OAS3
|ParameterizedServer|✗|OAS3
|ParameterizedServer|✓|OAS3
|ParameterStyling|✗|OAS3
|Callbacks|✗|OAS3
|LinkObjects|✗|OAS3
Expand Down

2 changes: 1 addition & 1 deletion
docs/generators/go.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -162,7 +162,7 @@ sidebar_label: go
|Examples|✓|OAS2,OAS3
|XMLStructureDefinitions|✗|OAS2,OAS3
|MultiServer|✗|OAS3
|ParameterizedServer|✗|OAS3
|ParameterizedServer|✓|OAS3
|ParameterStyling|✗|OAS3
|Callbacks|✗|OAS3
|LinkObjects|✗|OAS3
Expand Down

2 changes: 1 addition & 1 deletion
docs/generators/java.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -241,7 +241,7 @@ sidebar_label: java
|Examples|✓|OAS2,OAS3
|XMLStructureDefinitions|✗|OAS2,OAS3
|MultiServer|✗|OAS3
|ParameterizedServer|✗|OAS3
|ParameterizedServer|✓|OAS3
|ParameterStyling|✗|OAS3
|Callbacks|✗|OAS3
|LinkObjects|✗|OAS3
Expand Down

3 changes: 3 additions & 0 deletions
...s/openapi-generator/src/main/java/org/openapitools/codegen/languages/GoClientCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,6 +52,9 @@ public GoClientCodegen() {
 SecurityFeature.ApiKey,
 SecurityFeature.OAuth2_Implicit
 ))
 .includeGlobalFeatures(
 GlobalFeature.ParameterizedServer
 )
 .excludeGlobalFeatures(
 GlobalFeature.XMLStructureDefinitions,
 GlobalFeature.Callbacks,
Expand Down

4 changes: 4 additions & 0 deletions
...openapi-generator/src/main/java/org/openapitools/codegen/languages/JavaClientCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,7 @@
import org.openapitools.codegen.languages.features.GzipFeatures;
import org.openapitools.codegen.languages.features.PerformBeanValidationFeatures;
import org.openapitools.codegen.meta.features.DocumentationFeature;
import org.openapitools.codegen.meta.features.GlobalFeature;
import org.openapitools.codegen.templating.mustache.CaseFormatLambda;
import org.openapitools.codegen.utils.ProcessUtils;
import org.slf4j.Logger;
Expand DownExpand Up@@ -106,8 +107,10 @@ public class JavaClientCodegen extends AbstractJavaCodegen
 public JavaClientCodegen() {
 super();

 // TODO: Move GlobalFeature.ParameterizedServer to library: jersey after moving featureSet to generatorMetadata
 featureSet = getFeatureSet().modify()
 .includeDocumentationFeatures(DocumentationFeature.Readme)
 .includeGlobalFeatures(GlobalFeature.ParameterizedServer)
@bkabrdabkabrdaFeb 20, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?
@jimschubertjimschubertFeb 20, 2020•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
@bkabrdabkabrdaFeb 20, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IIUC it would be better to only add these files when jersey2 is used, CC @jirikuncar who authored the PR to confirm.
@jirikuncarjirikuncarFeb 20, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, the parameterised server per endpoint support is only in jersey2.
@jimschubertjimschubertFeb 21, 2020

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 GeneratorMetadataandDefaultCodegen.
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.
@jirikuncarjirikuncarFeb 21, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
@jirikuncarjirikuncarFeb 21, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was not clear. There are actually 2 features to track:
  1. Support for global server configuration with templated values (all Java)
  2. Support for server configuration per endpoint (only jersey2, go-experimental)
@jimschubertjimschubertFeb 22, 2020

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So, we probably need a GlobalFeature.ParameterizedServerPerOperation?
@jimschubertjimschubertFeb 22, 2020

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I created #5402 to track adding another feature for per-operation server variables.
 .build();

 outputFolder = "generated-code" + File.separator + "java";
Expand DownExpand Up@@ -290,6 +293,7 @@ public void processOpts() {
 supportingFiles.add(new SupportingFile("ApiClient.mustache", invokerFolder, "ApiClient.java"));
 supportingFiles.add(new SupportingFile("ServerConfiguration.mustache", invokerFolder, "ServerConfiguration.java"));
@jirikuncarjirikuncarFeb 21, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should stay here
@jirikuncarjirikuncarFeb 21, 2020•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
@jimschubertjimschubertFeb 21, 2020

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
 supportingFiles.add(new SupportingFile("ServerVariable.mustache", invokerFolder, "ServerVariable.java"));

 if (!(RESTTEMPLATE.equals(getLibrary()) || REST_ASSURED.equals(getLibrary()) || NATIVE.equals(getLibrary()) || MICROPROFILE.equals(getLibrary()))) {
 supportingFiles.add(new SupportingFile("StringUtil.mustache", invokerFolder, "StringUtil.java"));
 }
Expand Down

4 changes: 4 additions & 0 deletions
.../openapi-generator/src/test/java/org/openapitools/codegen/java/JavaClientCodegenTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -290,6 +290,8 @@ public void testGeneratePing() throws Exception {
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/ApiClient.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/ApiException.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/ApiResponse.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/ServerConfiguration.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/ServerVariable.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/auth/ApiKeyAuth.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/auth/Authentication.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/auth/HttpBasicAuth.java");
Expand DownExpand Up@@ -364,6 +366,8 @@ public void testGeneratePingSomeObj() throws Exception {
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/ApiClient.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/ApiException.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/ApiResponse.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/ServerConfiguration.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/ServerVariable.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/auth/ApiKeyAuth.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/auth/Authentication.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/auth/HttpBasicAuth.java");
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
[go][java] Document new parameterized server support by jimschubert · Pull Request #5380 · OpenAPITools/openapi-generator · GitHub
Skip to content
[go][java] Document new parameterized server support#5380

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.

 Sign up for GitHub

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

 Merged

jimschubert
merged 5 commits into

from

Feb 23, 2020
 Merged


[go][java] Document new parameterized server support
#5380
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
83eeeea

[go][java] Document new parameterized server support


jimschubert Feb 20, 2020
89af9cf

[java] Move parameterized server support to jersey2


jimschubert Feb 21, 2020
bf12323

[java] Regenerate samples


jimschubert Feb 21, 2020
1b45e49

[java] Include "global" server configuration for all java clients


jimschubert Feb 21, 2020
a6f98bc

[java] Add back ServerVariable for java clients


jimschubert Feb 22, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
docs/generators/go-experimental.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -162,7 +162,7 @@ sidebar_label: go-experimental
|Examples|✓|OAS2,OAS3
|XMLStructureDefinitions|✗|OAS2,OAS3
|MultiServer|✗|OAS3
|ParameterizedServer|✗|OAS3
|ParameterizedServer|✓|OAS3
|ParameterStyling|✗|OAS3
|Callbacks|✗|OAS3
|LinkObjects|✗|OAS3
Expand Down

2 changes: 1 addition & 1 deletion
docs/generators/go.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -162,7 +162,7 @@ sidebar_label: go
|Examples|✓|OAS2,OAS3
|XMLStructureDefinitions|✗|OAS2,OAS3
|MultiServer|✗|OAS3
|ParameterizedServer|✗|OAS3
|ParameterizedServer|✓|OAS3
|ParameterStyling|✗|OAS3
|Callbacks|✗|OAS3
|LinkObjects|✗|OAS3
Expand Down

2 changes: 1 addition & 1 deletion
docs/generators/java.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -241,7 +241,7 @@ sidebar_label: java
|Examples|✓|OAS2,OAS3
|XMLStructureDefinitions|✗|OAS2,OAS3
|MultiServer|✗|OAS3
|ParameterizedServer|✗|OAS3
|ParameterizedServer|✓|OAS3
|ParameterStyling|✗|OAS3
|Callbacks|✗|OAS3
|LinkObjects|✗|OAS3
Expand Down

3 changes: 3 additions & 0 deletions
...s/openapi-generator/src/main/java/org/openapitools/codegen/languages/GoClientCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,6 +52,9 @@ public GoClientCodegen() {
 SecurityFeature.ApiKey,
 SecurityFeature.OAuth2_Implicit
 ))
 .includeGlobalFeatures(
 GlobalFeature.ParameterizedServer
 )
 .excludeGlobalFeatures(
 GlobalFeature.XMLStructureDefinitions,
 GlobalFeature.Callbacks,
Expand Down

4 changes: 4 additions & 0 deletions
...openapi-generator/src/main/java/org/openapitools/codegen/languages/JavaClientCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,7 @@
import org.openapitools.codegen.languages.features.GzipFeatures;
import org.openapitools.codegen.languages.features.PerformBeanValidationFeatures;
import org.openapitools.codegen.meta.features.DocumentationFeature;
import org.openapitools.codegen.meta.features.GlobalFeature;
import org.openapitools.codegen.templating.mustache.CaseFormatLambda;
import org.openapitools.codegen.utils.ProcessUtils;
import org.slf4j.Logger;
Expand DownExpand Up@@ -106,8 +107,10 @@ public class JavaClientCodegen extends AbstractJavaCodegen
 public JavaClientCodegen() {
 super();

 // TODO: Move GlobalFeature.ParameterizedServer to library: jersey after moving featureSet to generatorMetadata
 featureSet = getFeatureSet().modify()
 .includeDocumentationFeatures(DocumentationFeature.Readme)
 .includeGlobalFeatures(GlobalFeature.ParameterizedServer)
@bkabrdabkabrdaFeb 20, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?
@jimschubertjimschubertFeb 20, 2020•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
@bkabrdabkabrdaFeb 20, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IIUC it would be better to only add these files when jersey2 is used, CC @jirikuncar who authored the PR to confirm.
@jirikuncarjirikuncarFeb 20, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, the parameterised server per endpoint support is only in jersey2.
@jimschubertjimschubertFeb 21, 2020

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 GeneratorMetadataandDefaultCodegen.
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.
@jirikuncarjirikuncarFeb 21, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
@jirikuncarjirikuncarFeb 21, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was not clear. There are actually 2 features to track:
  1. Support for global server configuration with templated values (all Java)
  2. Support for server configuration per endpoint (only jersey2, go-experimental)
@jimschubertjimschubertFeb 22, 2020

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So, we probably need a GlobalFeature.ParameterizedServerPerOperation?
@jimschubertjimschubertFeb 22, 2020

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I created #5402 to track adding another feature for per-operation server variables.
 .build();

 outputFolder = "generated-code" + File.separator + "java";
Expand DownExpand Up@@ -290,6 +293,7 @@ public void processOpts() {
 supportingFiles.add(new SupportingFile("ApiClient.mustache", invokerFolder, "ApiClient.java"));
 supportingFiles.add(new SupportingFile("ServerConfiguration.mustache", invokerFolder, "ServerConfiguration.java"));
@jirikuncarjirikuncarFeb 21, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should stay here
@jirikuncarjirikuncarFeb 21, 2020•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
@jimschubertjimschubertFeb 21, 2020

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
 supportingFiles.add(new SupportingFile("ServerVariable.mustache", invokerFolder, "ServerVariable.java"));

 if (!(RESTTEMPLATE.equals(getLibrary()) || REST_ASSURED.equals(getLibrary()) || NATIVE.equals(getLibrary()) || MICROPROFILE.equals(getLibrary()))) {
 supportingFiles.add(new SupportingFile("StringUtil.mustache", invokerFolder, "StringUtil.java"));
 }
Expand Down

4 changes: 4 additions & 0 deletions
.../openapi-generator/src/test/java/org/openapitools/codegen/java/JavaClientCodegenTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -290,6 +290,8 @@ public void testGeneratePing() throws Exception {
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/ApiClient.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/ApiException.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/ApiResponse.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/ServerConfiguration.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/ServerVariable.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/auth/ApiKeyAuth.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/auth/Authentication.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/auth/HttpBasicAuth.java");
Expand DownExpand Up@@ -364,6 +366,8 @@ public void testGeneratePingSomeObj() throws Exception {
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/ApiClient.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/ApiException.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/ApiResponse.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/ServerConfiguration.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/ServerVariable.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/auth/ApiKeyAuth.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/auth/Authentication.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/auth/HttpBasicAuth.java");
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[go][java] Document new parameterized server support by jimschubert · Pull Request #5380 · OpenAPITools/openapi-generator · GitHub
Skip to content
[go][java] Document new parameterized server support#5380

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.

 Sign up for GitHub

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

 Merged

jimschubert
merged 5 commits into

from

Feb 23, 2020
 Merged


[go][java] Document new parameterized server support
#5380
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
83eeeea

[go][java] Document new parameterized server support


jimschubert Feb 20, 2020
89af9cf

[java] Move parameterized server support to jersey2


jimschubert Feb 21, 2020
bf12323

[java] Regenerate samples


jimschubert Feb 21, 2020
1b45e49

[java] Include "global" server configuration for all java clients


jimschubert Feb 21, 2020
a6f98bc

[java] Add back ServerVariable for java clients


jimschubert Feb 22, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
docs/generators/go-experimental.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -162,7 +162,7 @@ sidebar_label: go-experimental
|Examples|✓|OAS2,OAS3
|XMLStructureDefinitions|✗|OAS2,OAS3
|MultiServer|✗|OAS3
|ParameterizedServer|✗|OAS3
|ParameterizedServer|✓|OAS3
|ParameterStyling|✗|OAS3
|Callbacks|✗|OAS3
|LinkObjects|✗|OAS3
Expand Down

2 changes: 1 addition & 1 deletion
docs/generators/go.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -162,7 +162,7 @@ sidebar_label: go
|Examples|✓|OAS2,OAS3
|XMLStructureDefinitions|✗|OAS2,OAS3
|MultiServer|✗|OAS3
|ParameterizedServer|✗|OAS3
|ParameterizedServer|✓|OAS3
|ParameterStyling|✗|OAS3
|Callbacks|✗|OAS3
|LinkObjects|✗|OAS3
Expand Down

2 changes: 1 addition & 1 deletion
docs/generators/java.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -241,7 +241,7 @@ sidebar_label: java
|Examples|✓|OAS2,OAS3
|XMLStructureDefinitions|✗|OAS2,OAS3
|MultiServer|✗|OAS3
|ParameterizedServer|✗|OAS3
|ParameterizedServer|✓|OAS3
|ParameterStyling|✗|OAS3
|Callbacks|✗|OAS3
|LinkObjects|✗|OAS3
Expand Down

3 changes: 3 additions & 0 deletions
...s/openapi-generator/src/main/java/org/openapitools/codegen/languages/GoClientCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,6 +52,9 @@ public GoClientCodegen() {
 SecurityFeature.ApiKey,
 SecurityFeature.OAuth2_Implicit
 ))
 .includeGlobalFeatures(
 GlobalFeature.ParameterizedServer
 )
 .excludeGlobalFeatures(
 GlobalFeature.XMLStructureDefinitions,
 GlobalFeature.Callbacks,
Expand Down

4 changes: 4 additions & 0 deletions
...openapi-generator/src/main/java/org/openapitools/codegen/languages/JavaClientCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,7 @@
import org.openapitools.codegen.languages.features.GzipFeatures;
import org.openapitools.codegen.languages.features.PerformBeanValidationFeatures;
import org.openapitools.codegen.meta.features.DocumentationFeature;
import org.openapitools.codegen.meta.features.GlobalFeature;
import org.openapitools.codegen.templating.mustache.CaseFormatLambda;
import org.openapitools.codegen.utils.ProcessUtils;
import org.slf4j.Logger;
Expand DownExpand Up@@ -106,8 +107,10 @@ public class JavaClientCodegen extends AbstractJavaCodegen
 public JavaClientCodegen() {
 super();

 // TODO: Move GlobalFeature.ParameterizedServer to library: jersey after moving featureSet to generatorMetadata
 featureSet = getFeatureSet().modify()
 .includeDocumentationFeatures(DocumentationFeature.Readme)
 .includeGlobalFeatures(GlobalFeature.ParameterizedServer)
@bkabrdabkabrdaFeb 20, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?
@jimschubertjimschubertFeb 20, 2020•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
@bkabrdabkabrdaFeb 20, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IIUC it would be better to only add these files when jersey2 is used, CC @jirikuncar who authored the PR to confirm.
@jirikuncarjirikuncarFeb 20, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, the parameterised server per endpoint support is only in jersey2.
@jimschubertjimschubertFeb 21, 2020

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 GeneratorMetadataandDefaultCodegen.
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.
@jirikuncarjirikuncarFeb 21, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
@jirikuncarjirikuncarFeb 21, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was not clear. There are actually 2 features to track:
  1. Support for global server configuration with templated values (all Java)
  2. Support for server configuration per endpoint (only jersey2, go-experimental)
@jimschubertjimschubertFeb 22, 2020

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So, we probably need a GlobalFeature.ParameterizedServerPerOperation?
@jimschubertjimschubertFeb 22, 2020

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I created #5402 to track adding another feature for per-operation server variables.
 .build();

 outputFolder = "generated-code" + File.separator + "java";
Expand DownExpand Up@@ -290,6 +293,7 @@ public void processOpts() {
 supportingFiles.add(new SupportingFile("ApiClient.mustache", invokerFolder, "ApiClient.java"));
 supportingFiles.add(new SupportingFile("ServerConfiguration.mustache", invokerFolder, "ServerConfiguration.java"));
@jirikuncarjirikuncarFeb 21, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should stay here
@jirikuncarjirikuncarFeb 21, 2020•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
@jimschubertjimschubertFeb 21, 2020

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
 supportingFiles.add(new SupportingFile("ServerVariable.mustache", invokerFolder, "ServerVariable.java"));

 if (!(RESTTEMPLATE.equals(getLibrary()) || REST_ASSURED.equals(getLibrary()) || NATIVE.equals(getLibrary()) || MICROPROFILE.equals(getLibrary()))) {
 supportingFiles.add(new SupportingFile("StringUtil.mustache", invokerFolder, "StringUtil.java"));
 }
Expand Down

4 changes: 4 additions & 0 deletions
.../openapi-generator/src/test/java/org/openapitools/codegen/java/JavaClientCodegenTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -290,6 +290,8 @@ public void testGeneratePing() throws Exception {
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/ApiClient.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/ApiException.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/ApiResponse.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/ServerConfiguration.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/ServerVariable.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/auth/ApiKeyAuth.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/auth/Authentication.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/auth/HttpBasicAuth.java");
Expand DownExpand Up@@ -364,6 +366,8 @@ public void testGeneratePingSomeObj() throws Exception {
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/ApiClient.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/ApiException.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/ApiResponse.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/ServerConfiguration.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/ServerVariable.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/auth/ApiKeyAuth.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/auth/Authentication.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/auth/HttpBasicAuth.java");
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[go][java] Document new parameterized server support by jimschubert · Pull Request #5380 · OpenAPITools/openapi-generator · GitHub
Skip to content
[go][java] Document new parameterized server support#5380

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.

 Sign up for GitHub

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

 Merged

jimschubert
merged 5 commits into

from

Feb 23, 2020
 Merged


[go][java] Document new parameterized server support
#5380
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
83eeeea

[go][java] Document new parameterized server support


jimschubert Feb 20, 2020
89af9cf

[java] Move parameterized server support to jersey2


jimschubert Feb 21, 2020
bf12323

[java] Regenerate samples


jimschubert Feb 21, 2020
1b45e49

[java] Include "global" server configuration for all java clients


jimschubert Feb 21, 2020
a6f98bc

[java] Add back ServerVariable for java clients


jimschubert Feb 22, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
docs/generators/go-experimental.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -162,7 +162,7 @@ sidebar_label: go-experimental
|Examples|✓|OAS2,OAS3
|XMLStructureDefinitions|✗|OAS2,OAS3
|MultiServer|✗|OAS3
|ParameterizedServer|✗|OAS3
|ParameterizedServer|✓|OAS3
|ParameterStyling|✗|OAS3
|Callbacks|✗|OAS3
|LinkObjects|✗|OAS3
Expand Down

2 changes: 1 addition & 1 deletion
docs/generators/go.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -162,7 +162,7 @@ sidebar_label: go
|Examples|✓|OAS2,OAS3
|XMLStructureDefinitions|✗|OAS2,OAS3
|MultiServer|✗|OAS3
|ParameterizedServer|✗|OAS3
|ParameterizedServer|✓|OAS3
|ParameterStyling|✗|OAS3
|Callbacks|✗|OAS3
|LinkObjects|✗|OAS3
Expand Down

2 changes: 1 addition & 1 deletion
docs/generators/java.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -241,7 +241,7 @@ sidebar_label: java
|Examples|✓|OAS2,OAS3
|XMLStructureDefinitions|✗|OAS2,OAS3
|MultiServer|✗|OAS3
|ParameterizedServer|✗|OAS3
|ParameterizedServer|✓|OAS3
|ParameterStyling|✗|OAS3
|Callbacks|✗|OAS3
|LinkObjects|✗|OAS3
Expand Down

3 changes: 3 additions & 0 deletions
...s/openapi-generator/src/main/java/org/openapitools/codegen/languages/GoClientCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,6 +52,9 @@ public GoClientCodegen() {
 SecurityFeature.ApiKey,
 SecurityFeature.OAuth2_Implicit
 ))
 .includeGlobalFeatures(
 GlobalFeature.ParameterizedServer
 )
 .excludeGlobalFeatures(
 GlobalFeature.XMLStructureDefinitions,
 GlobalFeature.Callbacks,
Expand Down

4 changes: 4 additions & 0 deletions
...openapi-generator/src/main/java/org/openapitools/codegen/languages/JavaClientCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,7 @@
import org.openapitools.codegen.languages.features.GzipFeatures;
import org.openapitools.codegen.languages.features.PerformBeanValidationFeatures;
import org.openapitools.codegen.meta.features.DocumentationFeature;
import org.openapitools.codegen.meta.features.GlobalFeature;
import org.openapitools.codegen.templating.mustache.CaseFormatLambda;
import org.openapitools.codegen.utils.ProcessUtils;
import org.slf4j.Logger;
Expand DownExpand Up@@ -106,8 +107,10 @@ public class JavaClientCodegen extends AbstractJavaCodegen
 public JavaClientCodegen() {
 super();

 // TODO: Move GlobalFeature.ParameterizedServer to library: jersey after moving featureSet to generatorMetadata
 featureSet = getFeatureSet().modify()
 .includeDocumentationFeatures(DocumentationFeature.Readme)
 .includeGlobalFeatures(GlobalFeature.ParameterizedServer)
@bkabrdabkabrdaFeb 20, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?
@jimschubertjimschubertFeb 20, 2020•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
@bkabrdabkabrdaFeb 20, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IIUC it would be better to only add these files when jersey2 is used, CC @jirikuncar who authored the PR to confirm.
@jirikuncarjirikuncarFeb 20, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, the parameterised server per endpoint support is only in jersey2.
@jimschubertjimschubertFeb 21, 2020

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 GeneratorMetadataandDefaultCodegen.
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.
@jirikuncarjirikuncarFeb 21, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
@jirikuncarjirikuncarFeb 21, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was not clear. There are actually 2 features to track:
  1. Support for global server configuration with templated values (all Java)
  2. Support for server configuration per endpoint (only jersey2, go-experimental)
@jimschubertjimschubertFeb 22, 2020

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So, we probably need a GlobalFeature.ParameterizedServerPerOperation?
@jimschubertjimschubertFeb 22, 2020

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I created #5402 to track adding another feature for per-operation server variables.
 .build();

 outputFolder = "generated-code" + File.separator + "java";
Expand DownExpand Up@@ -290,6 +293,7 @@ public void processOpts() {
 supportingFiles.add(new SupportingFile("ApiClient.mustache", invokerFolder, "ApiClient.java"));
 supportingFiles.add(new SupportingFile("ServerConfiguration.mustache", invokerFolder, "ServerConfiguration.java"));
@jirikuncarjirikuncarFeb 21, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should stay here
@jirikuncarjirikuncarFeb 21, 2020•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
@jimschubertjimschubertFeb 21, 2020

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
 supportingFiles.add(new SupportingFile("ServerVariable.mustache", invokerFolder, "ServerVariable.java"));

 if (!(RESTTEMPLATE.equals(getLibrary()) || REST_ASSURED.equals(getLibrary()) || NATIVE.equals(getLibrary()) || MICROPROFILE.equals(getLibrary()))) {
 supportingFiles.add(new SupportingFile("StringUtil.mustache", invokerFolder, "StringUtil.java"));
 }
Expand Down

4 changes: 4 additions & 0 deletions
.../openapi-generator/src/test/java/org/openapitools/codegen/java/JavaClientCodegenTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -290,6 +290,8 @@ public void testGeneratePing() throws Exception {
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/ApiClient.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/ApiException.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/ApiResponse.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/ServerConfiguration.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/ServerVariable.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/auth/ApiKeyAuth.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/auth/Authentication.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/auth/HttpBasicAuth.java");
Expand DownExpand Up@@ -364,6 +366,8 @@ public void testGeneratePingSomeObj() throws Exception {
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/ApiClient.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/ApiException.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/ApiResponse.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/ServerConfiguration.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/ServerVariable.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/auth/ApiKeyAuth.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/auth/Authentication.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/auth/HttpBasicAuth.java");
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
[go][java] Document new parameterized server support by jimschubert · Pull Request #5380 · OpenAPITools/openapi-generator · GitHub
Skip to content
[go][java] Document new parameterized server support#5380

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.

 Sign up for GitHub

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

 Merged

jimschubert
merged 5 commits into

from

Feb 23, 2020
 Merged


[go][java] Document new parameterized server support
#5380
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
83eeeea

[go][java] Document new parameterized server support


jimschubert Feb 20, 2020
89af9cf

[java] Move parameterized server support to jersey2


jimschubert Feb 21, 2020
bf12323

[java] Regenerate samples


jimschubert Feb 21, 2020
1b45e49

[java] Include "global" server configuration for all java clients


jimschubert Feb 21, 2020
a6f98bc

[java] Add back ServerVariable for java clients


jimschubert Feb 22, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
docs/generators/go-experimental.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -162,7 +162,7 @@ sidebar_label: go-experimental
|Examples|✓|OAS2,OAS3
|XMLStructureDefinitions|✗|OAS2,OAS3
|MultiServer|✗|OAS3
|ParameterizedServer|✗|OAS3
|ParameterizedServer|✓|OAS3
|ParameterStyling|✗|OAS3
|Callbacks|✗|OAS3
|LinkObjects|✗|OAS3
Expand Down

2 changes: 1 addition & 1 deletion
docs/generators/go.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -162,7 +162,7 @@ sidebar_label: go
|Examples|✓|OAS2,OAS3
|XMLStructureDefinitions|✗|OAS2,OAS3
|MultiServer|✗|OAS3
|ParameterizedServer|✗|OAS3
|ParameterizedServer|✓|OAS3
|ParameterStyling|✗|OAS3
|Callbacks|✗|OAS3
|LinkObjects|✗|OAS3
Expand Down

2 changes: 1 addition & 1 deletion
docs/generators/java.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -241,7 +241,7 @@ sidebar_label: java
|Examples|✓|OAS2,OAS3
|XMLStructureDefinitions|✗|OAS2,OAS3
|MultiServer|✗|OAS3
|ParameterizedServer|✗|OAS3
|ParameterizedServer|✓|OAS3
|ParameterStyling|✗|OAS3
|Callbacks|✗|OAS3
|LinkObjects|✗|OAS3
Expand Down

3 changes: 3 additions & 0 deletions
...s/openapi-generator/src/main/java/org/openapitools/codegen/languages/GoClientCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,6 +52,9 @@ public GoClientCodegen() {
 SecurityFeature.ApiKey,
 SecurityFeature.OAuth2_Implicit
 ))
 .includeGlobalFeatures(
 GlobalFeature.ParameterizedServer
 )
 .excludeGlobalFeatures(
 GlobalFeature.XMLStructureDefinitions,
 GlobalFeature.Callbacks,
Expand Down

4 changes: 4 additions & 0 deletions
...openapi-generator/src/main/java/org/openapitools/codegen/languages/JavaClientCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,7 @@
import org.openapitools.codegen.languages.features.GzipFeatures;
import org.openapitools.codegen.languages.features.PerformBeanValidationFeatures;
import org.openapitools.codegen.meta.features.DocumentationFeature;
import org.openapitools.codegen.meta.features.GlobalFeature;
import org.openapitools.codegen.templating.mustache.CaseFormatLambda;
import org.openapitools.codegen.utils.ProcessUtils;
import org.slf4j.Logger;
Expand DownExpand Up@@ -106,8 +107,10 @@ public class JavaClientCodegen extends AbstractJavaCodegen
 public JavaClientCodegen() {
 super();

 // TODO: Move GlobalFeature.ParameterizedServer to library: jersey after moving featureSet to generatorMetadata
 featureSet = getFeatureSet().modify()
 .includeDocumentationFeatures(DocumentationFeature.Readme)
 .includeGlobalFeatures(GlobalFeature.ParameterizedServer)
@bkabrdabkabrdaFeb 20, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?
@jimschubertjimschubertFeb 20, 2020•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
@bkabrdabkabrdaFeb 20, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IIUC it would be better to only add these files when jersey2 is used, CC @jirikuncar who authored the PR to confirm.
@jirikuncarjirikuncarFeb 20, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, the parameterised server per endpoint support is only in jersey2.
@jimschubertjimschubertFeb 21, 2020

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 GeneratorMetadataandDefaultCodegen.
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.
@jirikuncarjirikuncarFeb 21, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
@jirikuncarjirikuncarFeb 21, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was not clear. There are actually 2 features to track:
  1. Support for global server configuration with templated values (all Java)
  2. Support for server configuration per endpoint (only jersey2, go-experimental)
@jimschubertjimschubertFeb 22, 2020

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So, we probably need a GlobalFeature.ParameterizedServerPerOperation?
@jimschubertjimschubertFeb 22, 2020

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I created #5402 to track adding another feature for per-operation server variables.
 .build();

 outputFolder = "generated-code" + File.separator + "java";
Expand DownExpand Up@@ -290,6 +293,7 @@ public void processOpts() {
 supportingFiles.add(new SupportingFile("ApiClient.mustache", invokerFolder, "ApiClient.java"));
 supportingFiles.add(new SupportingFile("ServerConfiguration.mustache", invokerFolder, "ServerConfiguration.java"));
@jirikuncarjirikuncarFeb 21, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should stay here
@jirikuncarjirikuncarFeb 21, 2020•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
@jimschubertjimschubertFeb 21, 2020

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
 supportingFiles.add(new SupportingFile("ServerVariable.mustache", invokerFolder, "ServerVariable.java"));

 if (!(RESTTEMPLATE.equals(getLibrary()) || REST_ASSURED.equals(getLibrary()) || NATIVE.equals(getLibrary()) || MICROPROFILE.equals(getLibrary()))) {
 supportingFiles.add(new SupportingFile("StringUtil.mustache", invokerFolder, "StringUtil.java"));
 }
Expand Down

4 changes: 4 additions & 0 deletions
.../openapi-generator/src/test/java/org/openapitools/codegen/java/JavaClientCodegenTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -290,6 +290,8 @@ public void testGeneratePing() throws Exception {
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/ApiClient.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/ApiException.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/ApiResponse.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/ServerConfiguration.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/ServerVariable.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/auth/ApiKeyAuth.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/auth/Authentication.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/xyz/abcdef/auth/HttpBasicAuth.java");
Expand DownExpand Up@@ -364,6 +366,8 @@ public void testGeneratePingSomeObj() throws Exception {
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/ApiClient.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/ApiException.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/ApiResponse.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/ServerConfiguration.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/ServerVariable.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/auth/ApiKeyAuth.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/auth/Authentication.java");
 TestUtils.ensureContainsFile(generatedFiles, output, "src/main/java/zz/yyyy/invoker/xxxx/auth/HttpBasicAuth.java");
Expand Down