Skip to content

Fix array model of alias to array model missing inner type argument #4981

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
wing328 merged 4 commits into from
Mar 3, 2020
Merged

Fix array model of alias to array model missing inner type argument #4981

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e286ada
Add failing tests for typescript type declaration
bodograumann Jan 12, 2020
5a247d3
Refactor array and map child type string fallback
bodograumann Jan 12, 2020
87b78cd
Add unaliasSchema to typescript getTypeDeclaration
bodograumann Jan 12, 2020
2bace33
TypeScriptRxjs: Use Blob as file type declaration
bodograumann Mar 2, 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
34 changes: 15 additions & 19 deletions modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1734,12 +1734,23 @@ public String getSchemaType(Schema schema) {
}

protected Schema<?> getSchemaItems(ArraySchema schema) {
if (schema.getItems() != null) {
return schema.getItems();
} else {
Schema<?> items = schema.getItems();
if (items == null) {
LOGGER.error("Undefined array inner type for `{}`. Default to String.", schema.getName());
return new StringSchema().description("TODO default missing array inner type to string");
items = new StringSchema().description("TODO default missing array inner type to string");
schema.setItems(items);
}
return items;
}

protected Schema<?> getSchemaAdditionalProperties(Schema schema) {
Schema<?> inner = ModelUtils.getAdditionalProperties(schema);
if (inner == null) {
LOGGER.error("`{}` (map property) does not have a proper inner type defined. Default to type:string", schema.getName());
inner = new StringSchema().description("TODO default missing map inner type to string");
schema.setAdditionalProperties(inner);
}
return inner;
}

/**
Expand DownExpand Up@@ -2534,9 +2545,6 @@ public CodegenProperty fromProperty(String name, Schema p) {
// default to string if inner item is undefined
ArraySchema arraySchema = (ArraySchema) p;
Schema innerSchema = ModelUtils.unaliasSchema(this.openAPI, getSchemaItems(arraySchema), importMapping);
if (arraySchema.getItems() == null) {
arraySchema.setItems(innerSchema);
}
} else if (ModelUtils.isMapSchema(p)) {
Schema innerSchema = ModelUtils.unaliasSchema(this.openAPI, ModelUtils.getAdditionalProperties(p),
importMapping);
Expand DownExpand Up@@ -2616,9 +2624,6 @@ public CodegenProperty fromProperty(String name, Schema p) {
}
ArraySchema arraySchema = (ArraySchema) p;
Schema innerSchema = ModelUtils.unaliasSchema(this.openAPI, getSchemaItems(arraySchema), importMapping);
if (arraySchema.getItems() == null) {
arraySchema.setItems(innerSchema);
}
CodegenProperty cp = fromProperty(itemName, innerSchema);
updatePropertyForArray(property, cp);
} else if (ModelUtils.isMapSchema(p)) {
Expand DownExpand Up@@ -3499,9 +3504,6 @@ public CodegenParameter fromParameter(Parameter parameter, Set<String> imports)
if (ModelUtils.isArraySchema(parameterSchema)) { // for array parameter
final ArraySchema arraySchema = (ArraySchema) parameterSchema;
Schema inner = getSchemaItems(arraySchema);
if (arraySchema.getItems() == null) {
arraySchema.setItems(inner);
}

collectionFormat = getCollectionFormat(parameter);
// default to csv:
Expand DownExpand Up@@ -5098,9 +5100,6 @@ public List<CodegenParameter> fromRequestBodyToFormParameters(RequestBody body,
if (ModelUtils.isArraySchema(s)) {
final ArraySchema arraySchema = (ArraySchema) s;
Schema inner = getSchemaItems(arraySchema);
if (arraySchema.getItems() == null) {
arraySchema.setItems(inner);
}

codegenParameter = fromFormProperty(entry.getKey(), inner, imports);
CodegenProperty codegenProperty = fromProperty("inner", inner);
Expand DownExpand Up@@ -5300,9 +5299,6 @@ public CodegenParameter fromRequestBody(RequestBody body, Set<String> imports, S
} else if (ModelUtils.isArraySchema(schema)) {
final ArraySchema arraySchema = (ArraySchema) schema;
Schema inner = getSchemaItems(arraySchema);
if (arraySchema.getItems() == null) {
arraySchema.setItems(inner);
}
CodegenProperty codegenProperty = fromProperty("property", arraySchema);
imports.add(codegenProperty.baseType);
CodegenProperty innerCp = codegenProperty;
Expand Down
7 changes: 1 addition & 6 deletions ...enapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractJavaCodegen.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -740,12 +740,7 @@ public String getTypeDeclaration(Schema p) {
Schema<?> items = getSchemaItems((ArraySchema) p);
return getSchemaType(p) + "<" + getTypeDeclaration(ModelUtils.unaliasSchema(this.openAPI, items)) + ">";
} else if (ModelUtils.isMapSchema(p)) {
Schema inner = ModelUtils.getAdditionalProperties(p);
if (inner == null) {
LOGGER.error("`{}` (map property) does not have a proper inner type defined. Default to type:string", p.getName());
inner = new StringSchema().description("TODO default missing map inner type to string");
p.setAdditionalProperties(inner);
}
Schema<?> inner = getSchemaAdditionalProperties(p);
return getSchemaType(p) + "<String, " + getTypeDeclaration(ModelUtils.unaliasSchema(this.openAPI, inner)) + ">";
}
return super.getTypeDeclaration(p);
Expand Down
9 changes: 4 additions & 5 deletions ...tor/src/main/java/org/openapitools/codegen/languages/AbstractTypeScriptClientCodegen.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -378,13 +378,12 @@ public String toModelFilename(String name) {
@Override
public String getTypeDeclaration(Schema p) {
if (ModelUtils.isArraySchema(p)) {
ArraySchema ap = (ArraySchema) p;
Schema inner = ap.getItems();
return getSchemaType(p) + "<" + getTypeDeclaration(inner) + ">";
Schema<?> items = getSchemaItems((ArraySchema) p);
return getSchemaType(p) + "<" + getTypeDeclaration(ModelUtils.unaliasSchema(this.openAPI, items)) + ">";
} else if (ModelUtils.isMapSchema(p)) {
Schema inner = ModelUtils.getAdditionalProperties(p);
Schema<?> inner = getSchemaAdditionalProperties(p);
String nullSafeSuffix = getNullSafeAdditionalProps() ? " | undefined" : "";
return "{ [key: string]: " + getTypeDeclaration(inner) + nullSafeSuffix + "; }";
return "{ [key: string]: " + getTypeDeclaration(ModelUtils.unaliasSchema(this.openAPI, inner)) + nullSafeSuffix + "; }";
} else if (ModelUtils.isFileSchema(p)) {
return "any";
} else if (ModelUtils.isBinarySchema(p)) {
Expand Down
4 changes: 3 additions & 1 deletion ...nerator/src/main/java/org/openapitools/codegen/languages/TypeScriptRxjsClientCodegen.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -107,7 +107,9 @@ public boolean isDataTypeFile(final String dataType) {

@Override
public String getTypeDeclaration(Schema p) {
if (ModelUtils.isBinarySchema(p)) {
if (ModelUtils.isFileSchema(p)) {
return "Blob";
} else if (ModelUtils.isBinarySchema(p)) {
return "Blob";
}
return super.getTypeDeclaration(p);
Expand Down
33 changes: 33 additions & 0 deletions ...test/java/org/openapitools/codegen/typescript/fetch/TypeScriptFetchClientCodegenTest.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
package org.openapitools.codegen.typescript.fetch;

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.media.*;
import org.openapitools.codegen.CodegenConstants;
import org.openapitools.codegen.TestUtils;
import org.openapitools.codegen.languages.TypeScriptFetchClientCodegen;
import org.openapitools.codegen.utils.ModelUtils;
import org.testng.Assert;
import org.testng.annotations.Test;

Expand DownExpand Up@@ -69,4 +71,35 @@ public void toVarName() {
Assert.assertEquals(codegen.toVarName("valid_var"), "valid_var");
}

@Test
public void getTypeDeclarationTest() {
Schema<?> childSchema = new ArraySchema().items(new StringSchema());

OpenAPI api = TestUtils.createOpenAPI();
api.getComponents().addSchemas("Child", childSchema);

TypeScriptFetchClientCodegen codegen = new TypeScriptFetchClientCodegen();
codegen.setOpenAPI(api);

// Cf. issue #4968: Array of Alias of Array
Schema<?> parentSchema = new ArraySchema().items(
new Schema().$ref("#/components/schemas/Child")
);

ModelUtils.setGenerateAliasAsModel(false);
Assert.assertEquals(codegen.getTypeDeclaration(parentSchema), "Array<Array<string>>");

ModelUtils.setGenerateAliasAsModel(true);
Assert.assertEquals(codegen.getTypeDeclaration(parentSchema), "Array<Child>");

// Same for Map
parentSchema = new MapSchema().additionalProperties(new Schema().$ref("#/components/schemas/Child"));

ModelUtils.setGenerateAliasAsModel(false);
Assert.assertEquals(codegen.getTypeDeclaration(parentSchema), "{ [key: string]: Array<string>; }");

ModelUtils.setGenerateAliasAsModel(true);
Assert.assertEquals(codegen.getTypeDeclaration(parentSchema), "{ [key: string]: Child; }");
}

}
, '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" + '
Fix array model of alias to array model missing inner type argument by bodograumann · Pull Request #4981 · OpenAPITools/openapi-generator · GitHub
Skip to content
Fix array model of alias to array model missing inner type argument #4981

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

wing328
merged 4 commits into

from

Mar 3, 2020
 Merged


Fix array model of alias to array model missing inner type argument #4981
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
e286ada

Add failing tests for typescript type declaration


bodograumann Jan 12, 2020
5a247d3

Refactor array and map child type string fallback


bodograumann Jan 12, 2020
87b78cd

Add unaliasSchema to typescript getTypeDeclaration


bodograumann Jan 12, 2020
2bace33

TypeScriptRxjs: Use Blob as file type declaration


bodograumann Mar 2, 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


34 changes: 15 additions & 19 deletions
modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1734,12 +1734,23 @@ public String getSchemaType(Schema schema) {
 }

 protected Schema<?> getSchemaItems(ArraySchema schema) {
 if (schema.getItems() != null) {
 return schema.getItems();
 } else {
 Schema<?> items = schema.getItems();
 if (items == null) {
 LOGGER.error("Undefined array inner type for `{}`. Default to String.", schema.getName());
 return new StringSchema().description("TODO default missing array inner type to string");
 items = new StringSchema().description("TODO default missing array inner type to string");
 schema.setItems(items);
 }
 return items;
 }

 protected Schema<?> getSchemaAdditionalProperties(Schema schema) {
 Schema<?> inner = ModelUtils.getAdditionalProperties(schema);
 if (inner == null) {
 LOGGER.error("`{}` (map property) does not have a proper inner type defined. Default to type:string", schema.getName());
 inner = new StringSchema().description("TODO default missing map inner type to string");
 schema.setAdditionalProperties(inner);
 }
 return inner;
 }

 /**
Expand DownExpand Up@@ -2534,9 +2545,6 @@ public CodegenProperty fromProperty(String name, Schema p) {
 // default to string if inner item is undefined
 ArraySchema arraySchema = (ArraySchema) p;
 Schema innerSchema = ModelUtils.unaliasSchema(this.openAPI, getSchemaItems(arraySchema), importMapping);
 if (arraySchema.getItems() == null) {
 arraySchema.setItems(innerSchema);
 }
 } else if (ModelUtils.isMapSchema(p)) {
 Schema innerSchema = ModelUtils.unaliasSchema(this.openAPI, ModelUtils.getAdditionalProperties(p),
 importMapping);
Expand DownExpand Up@@ -2616,9 +2624,6 @@ public CodegenProperty fromProperty(String name, Schema p) {
 }
 ArraySchema arraySchema = (ArraySchema) p;
 Schema innerSchema = ModelUtils.unaliasSchema(this.openAPI, getSchemaItems(arraySchema), importMapping);
 if (arraySchema.getItems() == null) {
 arraySchema.setItems(innerSchema);
 }
 CodegenProperty cp = fromProperty(itemName, innerSchema);
 updatePropertyForArray(property, cp);
 } else if (ModelUtils.isMapSchema(p)) {
Expand DownExpand Up@@ -3499,9 +3504,6 @@ public CodegenParameter fromParameter(Parameter parameter, Set<String> imports)
 if (ModelUtils.isArraySchema(parameterSchema)) { // for array parameter
 final ArraySchema arraySchema = (ArraySchema) parameterSchema;
 Schema inner = getSchemaItems(arraySchema);
 if (arraySchema.getItems() == null) {
 arraySchema.setItems(inner);
 }

 collectionFormat = getCollectionFormat(parameter);
 // default to csv:
Expand DownExpand Up@@ -5098,9 +5100,6 @@ public List<CodegenParameter> fromRequestBodyToFormParameters(RequestBody body,
 if (ModelUtils.isArraySchema(s)) {
 final ArraySchema arraySchema = (ArraySchema) s;
 Schema inner = getSchemaItems(arraySchema);
 if (arraySchema.getItems() == null) {
 arraySchema.setItems(inner);
 }

 codegenParameter = fromFormProperty(entry.getKey(), inner, imports);
 CodegenProperty codegenProperty = fromProperty("inner", inner);
Expand DownExpand Up@@ -5300,9 +5299,6 @@ public CodegenParameter fromRequestBody(RequestBody body, Set<String> imports, S
 } else if (ModelUtils.isArraySchema(schema)) {
 final ArraySchema arraySchema = (ArraySchema) schema;
 Schema inner = getSchemaItems(arraySchema);
 if (arraySchema.getItems() == null) {
 arraySchema.setItems(inner);
 }
 CodegenProperty codegenProperty = fromProperty("property", arraySchema);
 imports.add(codegenProperty.baseType);
 CodegenProperty innerCp = codegenProperty;
Expand Down

7 changes: 1 addition & 6 deletions
...enapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractJavaCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -740,12 +740,7 @@ public String getTypeDeclaration(Schema p) {
 Schema<?> items = getSchemaItems((ArraySchema) p);
 return getSchemaType(p) + "<" + getTypeDeclaration(ModelUtils.unaliasSchema(this.openAPI, items)) + ">";
 } else if (ModelUtils.isMapSchema(p)) {
 Schema inner = ModelUtils.getAdditionalProperties(p);
 if (inner == null) {
 LOGGER.error("`{}` (map property) does not have a proper inner type defined. Default to type:string", p.getName());
 inner = new StringSchema().description("TODO default missing map inner type to string");
 p.setAdditionalProperties(inner);
 }
 Schema<?> inner = getSchemaAdditionalProperties(p);
 return getSchemaType(p) + "<String, " + getTypeDeclaration(ModelUtils.unaliasSchema(this.openAPI, inner)) + ">";
 }
 return super.getTypeDeclaration(p);
Expand Down

9 changes: 4 additions & 5 deletions
...tor/src/main/java/org/openapitools/codegen/languages/AbstractTypeScriptClientCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -378,13 +378,12 @@ public String toModelFilename(String name) {
 @Override
 public String getTypeDeclaration(Schema p) {
 if (ModelUtils.isArraySchema(p)) {
 ArraySchema ap = (ArraySchema) p;
 Schema inner = ap.getItems();
 return getSchemaType(p) + "<" + getTypeDeclaration(inner) + ">";
 Schema<?> items = getSchemaItems((ArraySchema) p);
 return getSchemaType(p) + "<" + getTypeDeclaration(ModelUtils.unaliasSchema(this.openAPI, items)) + ">";
 } else if (ModelUtils.isMapSchema(p)) {
 Schema inner = ModelUtils.getAdditionalProperties(p);
 Schema<?> inner = getSchemaAdditionalProperties(p);
 String nullSafeSuffix = getNullSafeAdditionalProps() ? " | undefined" : "";
 return "{ [key: string]: " + getTypeDeclaration(inner) + nullSafeSuffix + "; }";
 return "{ [key: string]: " + getTypeDeclaration(ModelUtils.unaliasSchema(this.openAPI, inner)) + nullSafeSuffix + "; }";
 } else if (ModelUtils.isFileSchema(p)) {
 return "any";
 } else if (ModelUtils.isBinarySchema(p)) {
Expand Down

4 changes: 3 additions & 1 deletion
...nerator/src/main/java/org/openapitools/codegen/languages/TypeScriptRxjsClientCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -107,7 +107,9 @@ public boolean isDataTypeFile(final String dataType) {

 @Override
 public String getTypeDeclaration(Schema p) {
 if (ModelUtils.isBinarySchema(p)) {
 if (ModelUtils.isFileSchema(p)) {
 return "Blob";
 } else if (ModelUtils.isBinarySchema(p)) {
 return "Blob";
 }
 return super.getTypeDeclaration(p);
Expand Down

33 changes: 33 additions & 0 deletions
...test/java/org/openapitools/codegen/typescript/fetch/TypeScriptFetchClientCodegenTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
package org.openapitools.codegen.typescript.fetch;

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.media.*;
import org.openapitools.codegen.CodegenConstants;
import org.openapitools.codegen.TestUtils;
import org.openapitools.codegen.languages.TypeScriptFetchClientCodegen;
import org.openapitools.codegen.utils.ModelUtils;
import org.testng.Assert;
import org.testng.annotations.Test;

Expand DownExpand Up@@ -69,4 +71,35 @@ public void toVarName() {
 Assert.assertEquals(codegen.toVarName("valid_var"), "valid_var");
 }

 @Test
 public void getTypeDeclarationTest() {
 Schema<?> childSchema = new ArraySchema().items(new StringSchema());

 OpenAPI api = TestUtils.createOpenAPI();
 api.getComponents().addSchemas("Child", childSchema);

 TypeScriptFetchClientCodegen codegen = new TypeScriptFetchClientCodegen();
 codegen.setOpenAPI(api);

 // Cf. issue #4968: Array of Alias of Array
 Schema<?> parentSchema = new ArraySchema().items(
 new Schema().$ref("#/components/schemas/Child")
 );

 ModelUtils.setGenerateAliasAsModel(false);
 Assert.assertEquals(codegen.getTypeDeclaration(parentSchema), "Array<Array<string>>");

 ModelUtils.setGenerateAliasAsModel(true);
 Assert.assertEquals(codegen.getTypeDeclaration(parentSchema), "Array<Child>");

 // Same for Map
 parentSchema = new MapSchema().additionalProperties(new Schema().$ref("#/components/schemas/Child"));

 ModelUtils.setGenerateAliasAsModel(false);
 Assert.assertEquals(codegen.getTypeDeclaration(parentSchema), "{ [key: string]: Array<string>; }");

 ModelUtils.setGenerateAliasAsModel(true);
 Assert.assertEquals(codegen.getTypeDeclaration(parentSchema), "{ [key: string]: Child; }");
 }

}

, '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('^' + ".*" + '
Fix array model of alias to array model missing inner type argument by bodograumann · Pull Request #4981 · OpenAPITools/openapi-generator · GitHub
Skip to content
Fix array model of alias to array model missing inner type argument #4981

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

wing328
merged 4 commits into

from

Mar 3, 2020
 Merged


Fix array model of alias to array model missing inner type argument #4981
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
e286ada

Add failing tests for typescript type declaration


bodograumann Jan 12, 2020
5a247d3

Refactor array and map child type string fallback


bodograumann Jan 12, 2020
87b78cd

Add unaliasSchema to typescript getTypeDeclaration


bodograumann Jan 12, 2020
2bace33

TypeScriptRxjs: Use Blob as file type declaration


bodograumann Mar 2, 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


34 changes: 15 additions & 19 deletions
modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1734,12 +1734,23 @@ public String getSchemaType(Schema schema) {
 }

 protected Schema<?> getSchemaItems(ArraySchema schema) {
 if (schema.getItems() != null) {
 return schema.getItems();
 } else {
 Schema<?> items = schema.getItems();
 if (items == null) {
 LOGGER.error("Undefined array inner type for `{}`. Default to String.", schema.getName());
 return new StringSchema().description("TODO default missing array inner type to string");
 items = new StringSchema().description("TODO default missing array inner type to string");
 schema.setItems(items);
 }
 return items;
 }

 protected Schema<?> getSchemaAdditionalProperties(Schema schema) {
 Schema<?> inner = ModelUtils.getAdditionalProperties(schema);
 if (inner == null) {
 LOGGER.error("`{}` (map property) does not have a proper inner type defined. Default to type:string", schema.getName());
 inner = new StringSchema().description("TODO default missing map inner type to string");
 schema.setAdditionalProperties(inner);
 }
 return inner;
 }

 /**
Expand DownExpand Up@@ -2534,9 +2545,6 @@ public CodegenProperty fromProperty(String name, Schema p) {
 // default to string if inner item is undefined
 ArraySchema arraySchema = (ArraySchema) p;
 Schema innerSchema = ModelUtils.unaliasSchema(this.openAPI, getSchemaItems(arraySchema), importMapping);
 if (arraySchema.getItems() == null) {
 arraySchema.setItems(innerSchema);
 }
 } else if (ModelUtils.isMapSchema(p)) {
 Schema innerSchema = ModelUtils.unaliasSchema(this.openAPI, ModelUtils.getAdditionalProperties(p),
 importMapping);
Expand DownExpand Up@@ -2616,9 +2624,6 @@ public CodegenProperty fromProperty(String name, Schema p) {
 }
 ArraySchema arraySchema = (ArraySchema) p;
 Schema innerSchema = ModelUtils.unaliasSchema(this.openAPI, getSchemaItems(arraySchema), importMapping);
 if (arraySchema.getItems() == null) {
 arraySchema.setItems(innerSchema);
 }
 CodegenProperty cp = fromProperty(itemName, innerSchema);
 updatePropertyForArray(property, cp);
 } else if (ModelUtils.isMapSchema(p)) {
Expand DownExpand Up@@ -3499,9 +3504,6 @@ public CodegenParameter fromParameter(Parameter parameter, Set<String> imports)
 if (ModelUtils.isArraySchema(parameterSchema)) { // for array parameter
 final ArraySchema arraySchema = (ArraySchema) parameterSchema;
 Schema inner = getSchemaItems(arraySchema);
 if (arraySchema.getItems() == null) {
 arraySchema.setItems(inner);
 }

 collectionFormat = getCollectionFormat(parameter);
 // default to csv:
Expand DownExpand Up@@ -5098,9 +5100,6 @@ public List<CodegenParameter> fromRequestBodyToFormParameters(RequestBody body,
 if (ModelUtils.isArraySchema(s)) {
 final ArraySchema arraySchema = (ArraySchema) s;
 Schema inner = getSchemaItems(arraySchema);
 if (arraySchema.getItems() == null) {
 arraySchema.setItems(inner);
 }

 codegenParameter = fromFormProperty(entry.getKey(), inner, imports);
 CodegenProperty codegenProperty = fromProperty("inner", inner);
Expand DownExpand Up@@ -5300,9 +5299,6 @@ public CodegenParameter fromRequestBody(RequestBody body, Set<String> imports, S
 } else if (ModelUtils.isArraySchema(schema)) {
 final ArraySchema arraySchema = (ArraySchema) schema;
 Schema inner = getSchemaItems(arraySchema);
 if (arraySchema.getItems() == null) {
 arraySchema.setItems(inner);
 }
 CodegenProperty codegenProperty = fromProperty("property", arraySchema);
 imports.add(codegenProperty.baseType);
 CodegenProperty innerCp = codegenProperty;
Expand Down

7 changes: 1 addition & 6 deletions
...enapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractJavaCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -740,12 +740,7 @@ public String getTypeDeclaration(Schema p) {
 Schema<?> items = getSchemaItems((ArraySchema) p);
 return getSchemaType(p) + "<" + getTypeDeclaration(ModelUtils.unaliasSchema(this.openAPI, items)) + ">";
 } else if (ModelUtils.isMapSchema(p)) {
 Schema inner = ModelUtils.getAdditionalProperties(p);
 if (inner == null) {
 LOGGER.error("`{}` (map property) does not have a proper inner type defined. Default to type:string", p.getName());
 inner = new StringSchema().description("TODO default missing map inner type to string");
 p.setAdditionalProperties(inner);
 }
 Schema<?> inner = getSchemaAdditionalProperties(p);
 return getSchemaType(p) + "<String, " + getTypeDeclaration(ModelUtils.unaliasSchema(this.openAPI, inner)) + ">";
 }
 return super.getTypeDeclaration(p);
Expand Down

9 changes: 4 additions & 5 deletions
...tor/src/main/java/org/openapitools/codegen/languages/AbstractTypeScriptClientCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -378,13 +378,12 @@ public String toModelFilename(String name) {
 @Override
 public String getTypeDeclaration(Schema p) {
 if (ModelUtils.isArraySchema(p)) {
 ArraySchema ap = (ArraySchema) p;
 Schema inner = ap.getItems();
 return getSchemaType(p) + "<" + getTypeDeclaration(inner) + ">";
 Schema<?> items = getSchemaItems((ArraySchema) p);
 return getSchemaType(p) + "<" + getTypeDeclaration(ModelUtils.unaliasSchema(this.openAPI, items)) + ">";
 } else if (ModelUtils.isMapSchema(p)) {
 Schema inner = ModelUtils.getAdditionalProperties(p);
 Schema<?> inner = getSchemaAdditionalProperties(p);
 String nullSafeSuffix = getNullSafeAdditionalProps() ? " | undefined" : "";
 return "{ [key: string]: " + getTypeDeclaration(inner) + nullSafeSuffix + "; }";
 return "{ [key: string]: " + getTypeDeclaration(ModelUtils.unaliasSchema(this.openAPI, inner)) + nullSafeSuffix + "; }";
 } else if (ModelUtils.isFileSchema(p)) {
 return "any";
 } else if (ModelUtils.isBinarySchema(p)) {
Expand Down

4 changes: 3 additions & 1 deletion
...nerator/src/main/java/org/openapitools/codegen/languages/TypeScriptRxjsClientCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -107,7 +107,9 @@ public boolean isDataTypeFile(final String dataType) {

 @Override
 public String getTypeDeclaration(Schema p) {
 if (ModelUtils.isBinarySchema(p)) {
 if (ModelUtils.isFileSchema(p)) {
 return "Blob";
 } else if (ModelUtils.isBinarySchema(p)) {
 return "Blob";
 }
 return super.getTypeDeclaration(p);
Expand Down

33 changes: 33 additions & 0 deletions
...test/java/org/openapitools/codegen/typescript/fetch/TypeScriptFetchClientCodegenTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
package org.openapitools.codegen.typescript.fetch;

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.media.*;
import org.openapitools.codegen.CodegenConstants;
import org.openapitools.codegen.TestUtils;
import org.openapitools.codegen.languages.TypeScriptFetchClientCodegen;
import org.openapitools.codegen.utils.ModelUtils;
import org.testng.Assert;
import org.testng.annotations.Test;

Expand DownExpand Up@@ -69,4 +71,35 @@ public void toVarName() {
 Assert.assertEquals(codegen.toVarName("valid_var"), "valid_var");
 }

 @Test
 public void getTypeDeclarationTest() {
 Schema<?> childSchema = new ArraySchema().items(new StringSchema());

 OpenAPI api = TestUtils.createOpenAPI();
 api.getComponents().addSchemas("Child", childSchema);

 TypeScriptFetchClientCodegen codegen = new TypeScriptFetchClientCodegen();
 codegen.setOpenAPI(api);

 // Cf. issue #4968: Array of Alias of Array
 Schema<?> parentSchema = new ArraySchema().items(
 new Schema().$ref("#/components/schemas/Child")
 );

 ModelUtils.setGenerateAliasAsModel(false);
 Assert.assertEquals(codegen.getTypeDeclaration(parentSchema), "Array<Array<string>>");

 ModelUtils.setGenerateAliasAsModel(true);
 Assert.assertEquals(codegen.getTypeDeclaration(parentSchema), "Array<Child>");

 // Same for Map
 parentSchema = new MapSchema().additionalProperties(new Schema().$ref("#/components/schemas/Child"));

 ModelUtils.setGenerateAliasAsModel(false);
 Assert.assertEquals(codegen.getTypeDeclaration(parentSchema), "{ [key: string]: Array<string>; }");

 ModelUtils.setGenerateAliasAsModel(true);
 Assert.assertEquals(codegen.getTypeDeclaration(parentSchema), "{ [key: string]: Child; }");
 }

}

, '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('^' + ".*" + '
Fix array model of alias to array model missing inner type argument by bodograumann · Pull Request #4981 · OpenAPITools/openapi-generator · GitHub
Skip to content
Fix array model of alias to array model missing inner type argument #4981

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

wing328
merged 4 commits into

from

Mar 3, 2020
 Merged


Fix array model of alias to array model missing inner type argument #4981
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
e286ada

Add failing tests for typescript type declaration


bodograumann Jan 12, 2020
5a247d3

Refactor array and map child type string fallback


bodograumann Jan 12, 2020
87b78cd

Add unaliasSchema to typescript getTypeDeclaration


bodograumann Jan 12, 2020
2bace33

TypeScriptRxjs: Use Blob as file type declaration


bodograumann Mar 2, 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


34 changes: 15 additions & 19 deletions
modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1734,12 +1734,23 @@ public String getSchemaType(Schema schema) {
 }

 protected Schema<?> getSchemaItems(ArraySchema schema) {
 if (schema.getItems() != null) {
 return schema.getItems();
 } else {
 Schema<?> items = schema.getItems();
 if (items == null) {
 LOGGER.error("Undefined array inner type for `{}`. Default to String.", schema.getName());
 return new StringSchema().description("TODO default missing array inner type to string");
 items = new StringSchema().description("TODO default missing array inner type to string");
 schema.setItems(items);
 }
 return items;
 }

 protected Schema<?> getSchemaAdditionalProperties(Schema schema) {
 Schema<?> inner = ModelUtils.getAdditionalProperties(schema);
 if (inner == null) {
 LOGGER.error("`{}` (map property) does not have a proper inner type defined. Default to type:string", schema.getName());
 inner = new StringSchema().description("TODO default missing map inner type to string");
 schema.setAdditionalProperties(inner);
 }
 return inner;
 }

 /**
Expand DownExpand Up@@ -2534,9 +2545,6 @@ public CodegenProperty fromProperty(String name, Schema p) {
 // default to string if inner item is undefined
 ArraySchema arraySchema = (ArraySchema) p;
 Schema innerSchema = ModelUtils.unaliasSchema(this.openAPI, getSchemaItems(arraySchema), importMapping);
 if (arraySchema.getItems() == null) {
 arraySchema.setItems(innerSchema);
 }
 } else if (ModelUtils.isMapSchema(p)) {
 Schema innerSchema = ModelUtils.unaliasSchema(this.openAPI, ModelUtils.getAdditionalProperties(p),
 importMapping);
Expand DownExpand Up@@ -2616,9 +2624,6 @@ public CodegenProperty fromProperty(String name, Schema p) {
 }
 ArraySchema arraySchema = (ArraySchema) p;
 Schema innerSchema = ModelUtils.unaliasSchema(this.openAPI, getSchemaItems(arraySchema), importMapping);
 if (arraySchema.getItems() == null) {
 arraySchema.setItems(innerSchema);
 }
 CodegenProperty cp = fromProperty(itemName, innerSchema);
 updatePropertyForArray(property, cp);
 } else if (ModelUtils.isMapSchema(p)) {
Expand DownExpand Up@@ -3499,9 +3504,6 @@ public CodegenParameter fromParameter(Parameter parameter, Set<String> imports)
 if (ModelUtils.isArraySchema(parameterSchema)) { // for array parameter
 final ArraySchema arraySchema = (ArraySchema) parameterSchema;
 Schema inner = getSchemaItems(arraySchema);
 if (arraySchema.getItems() == null) {
 arraySchema.setItems(inner);
 }

 collectionFormat = getCollectionFormat(parameter);
 // default to csv:
Expand DownExpand Up@@ -5098,9 +5100,6 @@ public List<CodegenParameter> fromRequestBodyToFormParameters(RequestBody body,
 if (ModelUtils.isArraySchema(s)) {
 final ArraySchema arraySchema = (ArraySchema) s;
 Schema inner = getSchemaItems(arraySchema);
 if (arraySchema.getItems() == null) {
 arraySchema.setItems(inner);
 }

 codegenParameter = fromFormProperty(entry.getKey(), inner, imports);
 CodegenProperty codegenProperty = fromProperty("inner", inner);
Expand DownExpand Up@@ -5300,9 +5299,6 @@ public CodegenParameter fromRequestBody(RequestBody body, Set<String> imports, S
 } else if (ModelUtils.isArraySchema(schema)) {
 final ArraySchema arraySchema = (ArraySchema) schema;
 Schema inner = getSchemaItems(arraySchema);
 if (arraySchema.getItems() == null) {
 arraySchema.setItems(inner);
 }
 CodegenProperty codegenProperty = fromProperty("property", arraySchema);
 imports.add(codegenProperty.baseType);
 CodegenProperty innerCp = codegenProperty;
Expand Down

7 changes: 1 addition & 6 deletions
...enapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractJavaCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -740,12 +740,7 @@ public String getTypeDeclaration(Schema p) {
 Schema<?> items = getSchemaItems((ArraySchema) p);
 return getSchemaType(p) + "<" + getTypeDeclaration(ModelUtils.unaliasSchema(this.openAPI, items)) + ">";
 } else if (ModelUtils.isMapSchema(p)) {
 Schema inner = ModelUtils.getAdditionalProperties(p);
 if (inner == null) {
 LOGGER.error("`{}` (map property) does not have a proper inner type defined. Default to type:string", p.getName());
 inner = new StringSchema().description("TODO default missing map inner type to string");
 p.setAdditionalProperties(inner);
 }
 Schema<?> inner = getSchemaAdditionalProperties(p);
 return getSchemaType(p) + "<String, " + getTypeDeclaration(ModelUtils.unaliasSchema(this.openAPI, inner)) + ">";
 }
 return super.getTypeDeclaration(p);
Expand Down

9 changes: 4 additions & 5 deletions
...tor/src/main/java/org/openapitools/codegen/languages/AbstractTypeScriptClientCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -378,13 +378,12 @@ public String toModelFilename(String name) {
 @Override
 public String getTypeDeclaration(Schema p) {
 if (ModelUtils.isArraySchema(p)) {
 ArraySchema ap = (ArraySchema) p;
 Schema inner = ap.getItems();
 return getSchemaType(p) + "<" + getTypeDeclaration(inner) + ">";
 Schema<?> items = getSchemaItems((ArraySchema) p);
 return getSchemaType(p) + "<" + getTypeDeclaration(ModelUtils.unaliasSchema(this.openAPI, items)) + ">";
 } else if (ModelUtils.isMapSchema(p)) {
 Schema inner = ModelUtils.getAdditionalProperties(p);
 Schema<?> inner = getSchemaAdditionalProperties(p);
 String nullSafeSuffix = getNullSafeAdditionalProps() ? " | undefined" : "";
 return "{ [key: string]: " + getTypeDeclaration(inner) + nullSafeSuffix + "; }";
 return "{ [key: string]: " + getTypeDeclaration(ModelUtils.unaliasSchema(this.openAPI, inner)) + nullSafeSuffix + "; }";
 } else if (ModelUtils.isFileSchema(p)) {
 return "any";
 } else if (ModelUtils.isBinarySchema(p)) {
Expand Down

4 changes: 3 additions & 1 deletion
...nerator/src/main/java/org/openapitools/codegen/languages/TypeScriptRxjsClientCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -107,7 +107,9 @@ public boolean isDataTypeFile(final String dataType) {

 @Override
 public String getTypeDeclaration(Schema p) {
 if (ModelUtils.isBinarySchema(p)) {
 if (ModelUtils.isFileSchema(p)) {
 return "Blob";
 } else if (ModelUtils.isBinarySchema(p)) {
 return "Blob";
 }
 return super.getTypeDeclaration(p);
Expand Down

33 changes: 33 additions & 0 deletions
...test/java/org/openapitools/codegen/typescript/fetch/TypeScriptFetchClientCodegenTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
package org.openapitools.codegen.typescript.fetch;

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.media.*;
import org.openapitools.codegen.CodegenConstants;
import org.openapitools.codegen.TestUtils;
import org.openapitools.codegen.languages.TypeScriptFetchClientCodegen;
import org.openapitools.codegen.utils.ModelUtils;
import org.testng.Assert;
import org.testng.annotations.Test;

Expand DownExpand Up@@ -69,4 +71,35 @@ public void toVarName() {
 Assert.assertEquals(codegen.toVarName("valid_var"), "valid_var");
 }

 @Test
 public void getTypeDeclarationTest() {
 Schema<?> childSchema = new ArraySchema().items(new StringSchema());

 OpenAPI api = TestUtils.createOpenAPI();
 api.getComponents().addSchemas("Child", childSchema);

 TypeScriptFetchClientCodegen codegen = new TypeScriptFetchClientCodegen();
 codegen.setOpenAPI(api);

 // Cf. issue #4968: Array of Alias of Array
 Schema<?> parentSchema = new ArraySchema().items(
 new Schema().$ref("#/components/schemas/Child")
 );

 ModelUtils.setGenerateAliasAsModel(false);
 Assert.assertEquals(codegen.getTypeDeclaration(parentSchema), "Array<Array<string>>");

 ModelUtils.setGenerateAliasAsModel(true);
 Assert.assertEquals(codegen.getTypeDeclaration(parentSchema), "Array<Child>");

 // Same for Map
 parentSchema = new MapSchema().additionalProperties(new Schema().$ref("#/components/schemas/Child"));

 ModelUtils.setGenerateAliasAsModel(false);
 Assert.assertEquals(codegen.getTypeDeclaration(parentSchema), "{ [key: string]: Array<string>; }");

 ModelUtils.setGenerateAliasAsModel(true);
 Assert.assertEquals(codegen.getTypeDeclaration(parentSchema), "{ [key: string]: Child; }");
 }

}

, '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" + '
Fix array model of alias to array model missing inner type argument by bodograumann · Pull Request #4981 · OpenAPITools/openapi-generator · GitHub
Skip to content
Fix array model of alias to array model missing inner type argument #4981

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

wing328
merged 4 commits into

from

Mar 3, 2020
 Merged


Fix array model of alias to array model missing inner type argument #4981
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
e286ada

Add failing tests for typescript type declaration


bodograumann Jan 12, 2020
5a247d3

Refactor array and map child type string fallback


bodograumann Jan 12, 2020
87b78cd

Add unaliasSchema to typescript getTypeDeclaration


bodograumann Jan 12, 2020
2bace33

TypeScriptRxjs: Use Blob as file type declaration


bodograumann Mar 2, 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


34 changes: 15 additions & 19 deletions
modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1734,12 +1734,23 @@ public String getSchemaType(Schema schema) {
 }

 protected Schema<?> getSchemaItems(ArraySchema schema) {
 if (schema.getItems() != null) {
 return schema.getItems();
 } else {
 Schema<?> items = schema.getItems();
 if (items == null) {
 LOGGER.error("Undefined array inner type for `{}`. Default to String.", schema.getName());
 return new StringSchema().description("TODO default missing array inner type to string");
 items = new StringSchema().description("TODO default missing array inner type to string");
 schema.setItems(items);
 }
 return items;
 }

 protected Schema<?> getSchemaAdditionalProperties(Schema schema) {
 Schema<?> inner = ModelUtils.getAdditionalProperties(schema);
 if (inner == null) {
 LOGGER.error("`{}` (map property) does not have a proper inner type defined. Default to type:string", schema.getName());
 inner = new StringSchema().description("TODO default missing map inner type to string");
 schema.setAdditionalProperties(inner);
 }
 return inner;
 }

 /**
Expand DownExpand Up@@ -2534,9 +2545,6 @@ public CodegenProperty fromProperty(String name, Schema p) {
 // default to string if inner item is undefined
 ArraySchema arraySchema = (ArraySchema) p;
 Schema innerSchema = ModelUtils.unaliasSchema(this.openAPI, getSchemaItems(arraySchema), importMapping);
 if (arraySchema.getItems() == null) {
 arraySchema.setItems(innerSchema);
 }
 } else if (ModelUtils.isMapSchema(p)) {
 Schema innerSchema = ModelUtils.unaliasSchema(this.openAPI, ModelUtils.getAdditionalProperties(p),
 importMapping);
Expand DownExpand Up@@ -2616,9 +2624,6 @@ public CodegenProperty fromProperty(String name, Schema p) {
 }
 ArraySchema arraySchema = (ArraySchema) p;
 Schema innerSchema = ModelUtils.unaliasSchema(this.openAPI, getSchemaItems(arraySchema), importMapping);
 if (arraySchema.getItems() == null) {
 arraySchema.setItems(innerSchema);
 }
 CodegenProperty cp = fromProperty(itemName, innerSchema);
 updatePropertyForArray(property, cp);
 } else if (ModelUtils.isMapSchema(p)) {
Expand DownExpand Up@@ -3499,9 +3504,6 @@ public CodegenParameter fromParameter(Parameter parameter, Set<String> imports)
 if (ModelUtils.isArraySchema(parameterSchema)) { // for array parameter
 final ArraySchema arraySchema = (ArraySchema) parameterSchema;
 Schema inner = getSchemaItems(arraySchema);
 if (arraySchema.getItems() == null) {
 arraySchema.setItems(inner);
 }

 collectionFormat = getCollectionFormat(parameter);
 // default to csv:
Expand DownExpand Up@@ -5098,9 +5100,6 @@ public List<CodegenParameter> fromRequestBodyToFormParameters(RequestBody body,
 if (ModelUtils.isArraySchema(s)) {
 final ArraySchema arraySchema = (ArraySchema) s;
 Schema inner = getSchemaItems(arraySchema);
 if (arraySchema.getItems() == null) {
 arraySchema.setItems(inner);
 }

 codegenParameter = fromFormProperty(entry.getKey(), inner, imports);
 CodegenProperty codegenProperty = fromProperty("inner", inner);
Expand DownExpand Up@@ -5300,9 +5299,6 @@ public CodegenParameter fromRequestBody(RequestBody body, Set<String> imports, S
 } else if (ModelUtils.isArraySchema(schema)) {
 final ArraySchema arraySchema = (ArraySchema) schema;
 Schema inner = getSchemaItems(arraySchema);
 if (arraySchema.getItems() == null) {
 arraySchema.setItems(inner);
 }
 CodegenProperty codegenProperty = fromProperty("property", arraySchema);
 imports.add(codegenProperty.baseType);
 CodegenProperty innerCp = codegenProperty;
Expand Down

7 changes: 1 addition & 6 deletions
...enapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractJavaCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -740,12 +740,7 @@ public String getTypeDeclaration(Schema p) {
 Schema<?> items = getSchemaItems((ArraySchema) p);
 return getSchemaType(p) + "<" + getTypeDeclaration(ModelUtils.unaliasSchema(this.openAPI, items)) + ">";
 } else if (ModelUtils.isMapSchema(p)) {
 Schema inner = ModelUtils.getAdditionalProperties(p);
 if (inner == null) {
 LOGGER.error("`{}` (map property) does not have a proper inner type defined. Default to type:string", p.getName());
 inner = new StringSchema().description("TODO default missing map inner type to string");
 p.setAdditionalProperties(inner);
 }
 Schema<?> inner = getSchemaAdditionalProperties(p);
 return getSchemaType(p) + "<String, " + getTypeDeclaration(ModelUtils.unaliasSchema(this.openAPI, inner)) + ">";
 }
 return super.getTypeDeclaration(p);
Expand Down

9 changes: 4 additions & 5 deletions
...tor/src/main/java/org/openapitools/codegen/languages/AbstractTypeScriptClientCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -378,13 +378,12 @@ public String toModelFilename(String name) {
 @Override
 public String getTypeDeclaration(Schema p) {
 if (ModelUtils.isArraySchema(p)) {
 ArraySchema ap = (ArraySchema) p;
 Schema inner = ap.getItems();
 return getSchemaType(p) + "<" + getTypeDeclaration(inner) + ">";
 Schema<?> items = getSchemaItems((ArraySchema) p);
 return getSchemaType(p) + "<" + getTypeDeclaration(ModelUtils.unaliasSchema(this.openAPI, items)) + ">";
 } else if (ModelUtils.isMapSchema(p)) {
 Schema inner = ModelUtils.getAdditionalProperties(p);
 Schema<?> inner = getSchemaAdditionalProperties(p);
 String nullSafeSuffix = getNullSafeAdditionalProps() ? " | undefined" : "";
 return "{ [key: string]: " + getTypeDeclaration(inner) + nullSafeSuffix + "; }";
 return "{ [key: string]: " + getTypeDeclaration(ModelUtils.unaliasSchema(this.openAPI, inner)) + nullSafeSuffix + "; }";
 } else if (ModelUtils.isFileSchema(p)) {
 return "any";
 } else if (ModelUtils.isBinarySchema(p)) {
Expand Down

4 changes: 3 additions & 1 deletion
...nerator/src/main/java/org/openapitools/codegen/languages/TypeScriptRxjsClientCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -107,7 +107,9 @@ public boolean isDataTypeFile(final String dataType) {

 @Override
 public String getTypeDeclaration(Schema p) {
 if (ModelUtils.isBinarySchema(p)) {
 if (ModelUtils.isFileSchema(p)) {
 return "Blob";
 } else if (ModelUtils.isBinarySchema(p)) {
 return "Blob";
 }
 return super.getTypeDeclaration(p);
Expand Down

33 changes: 33 additions & 0 deletions
...test/java/org/openapitools/codegen/typescript/fetch/TypeScriptFetchClientCodegenTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
package org.openapitools.codegen.typescript.fetch;

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.media.*;
import org.openapitools.codegen.CodegenConstants;
import org.openapitools.codegen.TestUtils;
import org.openapitools.codegen.languages.TypeScriptFetchClientCodegen;
import org.openapitools.codegen.utils.ModelUtils;
import org.testng.Assert;
import org.testng.annotations.Test;

Expand DownExpand Up@@ -69,4 +71,35 @@ public void toVarName() {
 Assert.assertEquals(codegen.toVarName("valid_var"), "valid_var");
 }

 @Test
 public void getTypeDeclarationTest() {
 Schema<?> childSchema = new ArraySchema().items(new StringSchema());

 OpenAPI api = TestUtils.createOpenAPI();
 api.getComponents().addSchemas("Child", childSchema);

 TypeScriptFetchClientCodegen codegen = new TypeScriptFetchClientCodegen();
 codegen.setOpenAPI(api);

 // Cf. issue #4968: Array of Alias of Array
 Schema<?> parentSchema = new ArraySchema().items(
 new Schema().$ref("#/components/schemas/Child")
 );

 ModelUtils.setGenerateAliasAsModel(false);
 Assert.assertEquals(codegen.getTypeDeclaration(parentSchema), "Array<Array<string>>");

 ModelUtils.setGenerateAliasAsModel(true);
 Assert.assertEquals(codegen.getTypeDeclaration(parentSchema), "Array<Child>");

 // Same for Map
 parentSchema = new MapSchema().additionalProperties(new Schema().$ref("#/components/schemas/Child"));

 ModelUtils.setGenerateAliasAsModel(false);
 Assert.assertEquals(codegen.getTypeDeclaration(parentSchema), "{ [key: string]: Array<string>; }");

 ModelUtils.setGenerateAliasAsModel(true);
 Assert.assertEquals(codegen.getTypeDeclaration(parentSchema), "{ [key: string]: Child; }");
 }

}

, '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('^' + ".*" + '
Fix array model of alias to array model missing inner type argument by bodograumann · Pull Request #4981 · OpenAPITools/openapi-generator · GitHub
Skip to content
Fix array model of alias to array model missing inner type argument #4981

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

wing328
merged 4 commits into

from

Mar 3, 2020
 Merged


Fix array model of alias to array model missing inner type argument #4981
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
e286ada

Add failing tests for typescript type declaration


bodograumann Jan 12, 2020
5a247d3

Refactor array and map child type string fallback


bodograumann Jan 12, 2020
87b78cd

Add unaliasSchema to typescript getTypeDeclaration


bodograumann Jan 12, 2020
2bace33

TypeScriptRxjs: Use Blob as file type declaration


bodograumann Mar 2, 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


34 changes: 15 additions & 19 deletions
modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1734,12 +1734,23 @@ public String getSchemaType(Schema schema) {
 }

 protected Schema<?> getSchemaItems(ArraySchema schema) {
 if (schema.getItems() != null) {
 return schema.getItems();
 } else {
 Schema<?> items = schema.getItems();
 if (items == null) {
 LOGGER.error("Undefined array inner type for `{}`. Default to String.", schema.getName());
 return new StringSchema().description("TODO default missing array inner type to string");
 items = new StringSchema().description("TODO default missing array inner type to string");
 schema.setItems(items);
 }
 return items;
 }

 protected Schema<?> getSchemaAdditionalProperties(Schema schema) {
 Schema<?> inner = ModelUtils.getAdditionalProperties(schema);
 if (inner == null) {
 LOGGER.error("`{}` (map property) does not have a proper inner type defined. Default to type:string", schema.getName());
 inner = new StringSchema().description("TODO default missing map inner type to string");
 schema.setAdditionalProperties(inner);
 }
 return inner;
 }

 /**
Expand DownExpand Up@@ -2534,9 +2545,6 @@ public CodegenProperty fromProperty(String name, Schema p) {
 // default to string if inner item is undefined
 ArraySchema arraySchema = (ArraySchema) p;
 Schema innerSchema = ModelUtils.unaliasSchema(this.openAPI, getSchemaItems(arraySchema), importMapping);
 if (arraySchema.getItems() == null) {
 arraySchema.setItems(innerSchema);
 }
 } else if (ModelUtils.isMapSchema(p)) {
 Schema innerSchema = ModelUtils.unaliasSchema(this.openAPI, ModelUtils.getAdditionalProperties(p),
 importMapping);
Expand DownExpand Up@@ -2616,9 +2624,6 @@ public CodegenProperty fromProperty(String name, Schema p) {
 }
 ArraySchema arraySchema = (ArraySchema) p;
 Schema innerSchema = ModelUtils.unaliasSchema(this.openAPI, getSchemaItems(arraySchema), importMapping);
 if (arraySchema.getItems() == null) {
 arraySchema.setItems(innerSchema);
 }
 CodegenProperty cp = fromProperty(itemName, innerSchema);
 updatePropertyForArray(property, cp);
 } else if (ModelUtils.isMapSchema(p)) {
Expand DownExpand Up@@ -3499,9 +3504,6 @@ public CodegenParameter fromParameter(Parameter parameter, Set<String> imports)
 if (ModelUtils.isArraySchema(parameterSchema)) { // for array parameter
 final ArraySchema arraySchema = (ArraySchema) parameterSchema;
 Schema inner = getSchemaItems(arraySchema);
 if (arraySchema.getItems() == null) {
 arraySchema.setItems(inner);
 }

 collectionFormat = getCollectionFormat(parameter);
 // default to csv:
Expand DownExpand Up@@ -5098,9 +5100,6 @@ public List<CodegenParameter> fromRequestBodyToFormParameters(RequestBody body,
 if (ModelUtils.isArraySchema(s)) {
 final ArraySchema arraySchema = (ArraySchema) s;
 Schema inner = getSchemaItems(arraySchema);
 if (arraySchema.getItems() == null) {
 arraySchema.setItems(inner);
 }

 codegenParameter = fromFormProperty(entry.getKey(), inner, imports);
 CodegenProperty codegenProperty = fromProperty("inner", inner);
Expand DownExpand Up@@ -5300,9 +5299,6 @@ public CodegenParameter fromRequestBody(RequestBody body, Set<String> imports, S
 } else if (ModelUtils.isArraySchema(schema)) {
 final ArraySchema arraySchema = (ArraySchema) schema;
 Schema inner = getSchemaItems(arraySchema);
 if (arraySchema.getItems() == null) {
 arraySchema.setItems(inner);
 }
 CodegenProperty codegenProperty = fromProperty("property", arraySchema);
 imports.add(codegenProperty.baseType);
 CodegenProperty innerCp = codegenProperty;
Expand Down

7 changes: 1 addition & 6 deletions
...enapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractJavaCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -740,12 +740,7 @@ public String getTypeDeclaration(Schema p) {
 Schema<?> items = getSchemaItems((ArraySchema) p);
 return getSchemaType(p) + "<" + getTypeDeclaration(ModelUtils.unaliasSchema(this.openAPI, items)) + ">";
 } else if (ModelUtils.isMapSchema(p)) {
 Schema inner = ModelUtils.getAdditionalProperties(p);
 if (inner == null) {
 LOGGER.error("`{}` (map property) does not have a proper inner type defined. Default to type:string", p.getName());
 inner = new StringSchema().description("TODO default missing map inner type to string");
 p.setAdditionalProperties(inner);
 }
 Schema<?> inner = getSchemaAdditionalProperties(p);
 return getSchemaType(p) + "<String, " + getTypeDeclaration(ModelUtils.unaliasSchema(this.openAPI, inner)) + ">";
 }
 return super.getTypeDeclaration(p);
Expand Down

9 changes: 4 additions & 5 deletions
...tor/src/main/java/org/openapitools/codegen/languages/AbstractTypeScriptClientCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -378,13 +378,12 @@ public String toModelFilename(String name) {
 @Override
 public String getTypeDeclaration(Schema p) {
 if (ModelUtils.isArraySchema(p)) {
 ArraySchema ap = (ArraySchema) p;
 Schema inner = ap.getItems();
 return getSchemaType(p) + "<" + getTypeDeclaration(inner) + ">";
 Schema<?> items = getSchemaItems((ArraySchema) p);
 return getSchemaType(p) + "<" + getTypeDeclaration(ModelUtils.unaliasSchema(this.openAPI, items)) + ">";
 } else if (ModelUtils.isMapSchema(p)) {
 Schema inner = ModelUtils.getAdditionalProperties(p);
 Schema<?> inner = getSchemaAdditionalProperties(p);
 String nullSafeSuffix = getNullSafeAdditionalProps() ? " | undefined" : "";
 return "{ [key: string]: " + getTypeDeclaration(inner) + nullSafeSuffix + "; }";
 return "{ [key: string]: " + getTypeDeclaration(ModelUtils.unaliasSchema(this.openAPI, inner)) + nullSafeSuffix + "; }";
 } else if (ModelUtils.isFileSchema(p)) {
 return "any";
 } else if (ModelUtils.isBinarySchema(p)) {
Expand Down

4 changes: 3 additions & 1 deletion
...nerator/src/main/java/org/openapitools/codegen/languages/TypeScriptRxjsClientCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -107,7 +107,9 @@ public boolean isDataTypeFile(final String dataType) {

 @Override
 public String getTypeDeclaration(Schema p) {
 if (ModelUtils.isBinarySchema(p)) {
 if (ModelUtils.isFileSchema(p)) {
 return "Blob";
 } else if (ModelUtils.isBinarySchema(p)) {
 return "Blob";
 }
 return super.getTypeDeclaration(p);
Expand Down

33 changes: 33 additions & 0 deletions
...test/java/org/openapitools/codegen/typescript/fetch/TypeScriptFetchClientCodegenTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
package org.openapitools.codegen.typescript.fetch;

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.media.*;
import org.openapitools.codegen.CodegenConstants;
import org.openapitools.codegen.TestUtils;
import org.openapitools.codegen.languages.TypeScriptFetchClientCodegen;
import org.openapitools.codegen.utils.ModelUtils;
import org.testng.Assert;
import org.testng.annotations.Test;

Expand DownExpand Up@@ -69,4 +71,35 @@ public void toVarName() {
 Assert.assertEquals(codegen.toVarName("valid_var"), "valid_var");
 }

 @Test
 public void getTypeDeclarationTest() {
 Schema<?> childSchema = new ArraySchema().items(new StringSchema());

 OpenAPI api = TestUtils.createOpenAPI();
 api.getComponents().addSchemas("Child", childSchema);

 TypeScriptFetchClientCodegen codegen = new TypeScriptFetchClientCodegen();
 codegen.setOpenAPI(api);

 // Cf. issue #4968: Array of Alias of Array
 Schema<?> parentSchema = new ArraySchema().items(
 new Schema().$ref("#/components/schemas/Child")
 );

 ModelUtils.setGenerateAliasAsModel(false);
 Assert.assertEquals(codegen.getTypeDeclaration(parentSchema), "Array<Array<string>>");

 ModelUtils.setGenerateAliasAsModel(true);
 Assert.assertEquals(codegen.getTypeDeclaration(parentSchema), "Array<Child>");

 // Same for Map
 parentSchema = new MapSchema().additionalProperties(new Schema().$ref("#/components/schemas/Child"));

 ModelUtils.setGenerateAliasAsModel(false);
 Assert.assertEquals(codegen.getTypeDeclaration(parentSchema), "{ [key: string]: Array<string>; }");

 ModelUtils.setGenerateAliasAsModel(true);
 Assert.assertEquals(codegen.getTypeDeclaration(parentSchema), "{ [key: string]: Child; }");
 }

}

, '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('^' + ".*" + '
Fix array model of alias to array model missing inner type argument by bodograumann · Pull Request #4981 · OpenAPITools/openapi-generator · GitHub
Skip to content
Fix array model of alias to array model missing inner type argument #4981

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

wing328
merged 4 commits into

from

Mar 3, 2020
 Merged


Fix array model of alias to array model missing inner type argument #4981
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
e286ada

Add failing tests for typescript type declaration


bodograumann Jan 12, 2020
5a247d3

Refactor array and map child type string fallback


bodograumann Jan 12, 2020
87b78cd

Add unaliasSchema to typescript getTypeDeclaration


bodograumann Jan 12, 2020
2bace33

TypeScriptRxjs: Use Blob as file type declaration


bodograumann Mar 2, 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


34 changes: 15 additions & 19 deletions
modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1734,12 +1734,23 @@ public String getSchemaType(Schema schema) {
 }

 protected Schema<?> getSchemaItems(ArraySchema schema) {
 if (schema.getItems() != null) {
 return schema.getItems();
 } else {
 Schema<?> items = schema.getItems();
 if (items == null) {
 LOGGER.error("Undefined array inner type for `{}`. Default to String.", schema.getName());
 return new StringSchema().description("TODO default missing array inner type to string");
 items = new StringSchema().description("TODO default missing array inner type to string");
 schema.setItems(items);
 }
 return items;
 }

 protected Schema<?> getSchemaAdditionalProperties(Schema schema) {
 Schema<?> inner = ModelUtils.getAdditionalProperties(schema);
 if (inner == null) {
 LOGGER.error("`{}` (map property) does not have a proper inner type defined. Default to type:string", schema.getName());
 inner = new StringSchema().description("TODO default missing map inner type to string");
 schema.setAdditionalProperties(inner);
 }
 return inner;
 }

 /**
Expand DownExpand Up@@ -2534,9 +2545,6 @@ public CodegenProperty fromProperty(String name, Schema p) {
 // default to string if inner item is undefined
 ArraySchema arraySchema = (ArraySchema) p;
 Schema innerSchema = ModelUtils.unaliasSchema(this.openAPI, getSchemaItems(arraySchema), importMapping);
 if (arraySchema.getItems() == null) {
 arraySchema.setItems(innerSchema);
 }
 } else if (ModelUtils.isMapSchema(p)) {
 Schema innerSchema = ModelUtils.unaliasSchema(this.openAPI, ModelUtils.getAdditionalProperties(p),
 importMapping);
Expand DownExpand Up@@ -2616,9 +2624,6 @@ public CodegenProperty fromProperty(String name, Schema p) {
 }
 ArraySchema arraySchema = (ArraySchema) p;
 Schema innerSchema = ModelUtils.unaliasSchema(this.openAPI, getSchemaItems(arraySchema), importMapping);
 if (arraySchema.getItems() == null) {
 arraySchema.setItems(innerSchema);
 }
 CodegenProperty cp = fromProperty(itemName, innerSchema);
 updatePropertyForArray(property, cp);
 } else if (ModelUtils.isMapSchema(p)) {
Expand DownExpand Up@@ -3499,9 +3504,6 @@ public CodegenParameter fromParameter(Parameter parameter, Set<String> imports)
 if (ModelUtils.isArraySchema(parameterSchema)) { // for array parameter
 final ArraySchema arraySchema = (ArraySchema) parameterSchema;
 Schema inner = getSchemaItems(arraySchema);
 if (arraySchema.getItems() == null) {
 arraySchema.setItems(inner);
 }

 collectionFormat = getCollectionFormat(parameter);
 // default to csv:
Expand DownExpand Up@@ -5098,9 +5100,6 @@ public List<CodegenParameter> fromRequestBodyToFormParameters(RequestBody body,
 if (ModelUtils.isArraySchema(s)) {
 final ArraySchema arraySchema = (ArraySchema) s;
 Schema inner = getSchemaItems(arraySchema);
 if (arraySchema.getItems() == null) {
 arraySchema.setItems(inner);
 }

 codegenParameter = fromFormProperty(entry.getKey(), inner, imports);
 CodegenProperty codegenProperty = fromProperty("inner", inner);
Expand DownExpand Up@@ -5300,9 +5299,6 @@ public CodegenParameter fromRequestBody(RequestBody body, Set<String> imports, S
 } else if (ModelUtils.isArraySchema(schema)) {
 final ArraySchema arraySchema = (ArraySchema) schema;
 Schema inner = getSchemaItems(arraySchema);
 if (arraySchema.getItems() == null) {
 arraySchema.setItems(inner);
 }
 CodegenProperty codegenProperty = fromProperty("property", arraySchema);
 imports.add(codegenProperty.baseType);
 CodegenProperty innerCp = codegenProperty;
Expand Down

7 changes: 1 addition & 6 deletions
...enapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractJavaCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -740,12 +740,7 @@ public String getTypeDeclaration(Schema p) {
 Schema<?> items = getSchemaItems((ArraySchema) p);
 return getSchemaType(p) + "<" + getTypeDeclaration(ModelUtils.unaliasSchema(this.openAPI, items)) + ">";
 } else if (ModelUtils.isMapSchema(p)) {
 Schema inner = ModelUtils.getAdditionalProperties(p);
 if (inner == null) {
 LOGGER.error("`{}` (map property) does not have a proper inner type defined. Default to type:string", p.getName());
 inner = new StringSchema().description("TODO default missing map inner type to string");
 p.setAdditionalProperties(inner);
 }
 Schema<?> inner = getSchemaAdditionalProperties(p);
 return getSchemaType(p) + "<String, " + getTypeDeclaration(ModelUtils.unaliasSchema(this.openAPI, inner)) + ">";
 }
 return super.getTypeDeclaration(p);
Expand Down

9 changes: 4 additions & 5 deletions
...tor/src/main/java/org/openapitools/codegen/languages/AbstractTypeScriptClientCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -378,13 +378,12 @@ public String toModelFilename(String name) {
 @Override
 public String getTypeDeclaration(Schema p) {
 if (ModelUtils.isArraySchema(p)) {
 ArraySchema ap = (ArraySchema) p;
 Schema inner = ap.getItems();
 return getSchemaType(p) + "<" + getTypeDeclaration(inner) + ">";
 Schema<?> items = getSchemaItems((ArraySchema) p);
 return getSchemaType(p) + "<" + getTypeDeclaration(ModelUtils.unaliasSchema(this.openAPI, items)) + ">";
 } else if (ModelUtils.isMapSchema(p)) {
 Schema inner = ModelUtils.getAdditionalProperties(p);
 Schema<?> inner = getSchemaAdditionalProperties(p);
 String nullSafeSuffix = getNullSafeAdditionalProps() ? " | undefined" : "";
 return "{ [key: string]: " + getTypeDeclaration(inner) + nullSafeSuffix + "; }";
 return "{ [key: string]: " + getTypeDeclaration(ModelUtils.unaliasSchema(this.openAPI, inner)) + nullSafeSuffix + "; }";
 } else if (ModelUtils.isFileSchema(p)) {
 return "any";
 } else if (ModelUtils.isBinarySchema(p)) {
Expand Down

4 changes: 3 additions & 1 deletion
...nerator/src/main/java/org/openapitools/codegen/languages/TypeScriptRxjsClientCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -107,7 +107,9 @@ public boolean isDataTypeFile(final String dataType) {

 @Override
 public String getTypeDeclaration(Schema p) {
 if (ModelUtils.isBinarySchema(p)) {
 if (ModelUtils.isFileSchema(p)) {
 return "Blob";
 } else if (ModelUtils.isBinarySchema(p)) {
 return "Blob";
 }
 return super.getTypeDeclaration(p);
Expand Down

33 changes: 33 additions & 0 deletions
...test/java/org/openapitools/codegen/typescript/fetch/TypeScriptFetchClientCodegenTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
package org.openapitools.codegen.typescript.fetch;

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.media.*;
import org.openapitools.codegen.CodegenConstants;
import org.openapitools.codegen.TestUtils;
import org.openapitools.codegen.languages.TypeScriptFetchClientCodegen;
import org.openapitools.codegen.utils.ModelUtils;
import org.testng.Assert;
import org.testng.annotations.Test;

Expand DownExpand Up@@ -69,4 +71,35 @@ public void toVarName() {
 Assert.assertEquals(codegen.toVarName("valid_var"), "valid_var");
 }

 @Test
 public void getTypeDeclarationTest() {
 Schema<?> childSchema = new ArraySchema().items(new StringSchema());

 OpenAPI api = TestUtils.createOpenAPI();
 api.getComponents().addSchemas("Child", childSchema);

 TypeScriptFetchClientCodegen codegen = new TypeScriptFetchClientCodegen();
 codegen.setOpenAPI(api);

 // Cf. issue #4968: Array of Alias of Array
 Schema<?> parentSchema = new ArraySchema().items(
 new Schema().$ref("#/components/schemas/Child")
 );

 ModelUtils.setGenerateAliasAsModel(false);
 Assert.assertEquals(codegen.getTypeDeclaration(parentSchema), "Array<Array<string>>");

 ModelUtils.setGenerateAliasAsModel(true);
 Assert.assertEquals(codegen.getTypeDeclaration(parentSchema), "Array<Child>");

 // Same for Map
 parentSchema = new MapSchema().additionalProperties(new Schema().$ref("#/components/schemas/Child"));

 ModelUtils.setGenerateAliasAsModel(false);
 Assert.assertEquals(codegen.getTypeDeclaration(parentSchema), "{ [key: string]: Array<string>; }");

 ModelUtils.setGenerateAliasAsModel(true);
 Assert.assertEquals(codegen.getTypeDeclaration(parentSchema), "{ [key: string]: Child; }");
 }

}

, '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); }
})();
})();
Fix array model of alias to array model missing inner type argument by bodograumann · Pull Request #4981 · OpenAPITools/openapi-generator · GitHub
Skip to content
Fix array model of alias to array model missing inner type argument #4981

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

wing328
merged 4 commits into

from

Mar 3, 2020
 Merged


Fix array model of alias to array model missing inner type argument #4981
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
e286ada

Add failing tests for typescript type declaration


bodograumann Jan 12, 2020
5a247d3

Refactor array and map child type string fallback


bodograumann Jan 12, 2020
87b78cd

Add unaliasSchema to typescript getTypeDeclaration


bodograumann Jan 12, 2020
2bace33

TypeScriptRxjs: Use Blob as file type declaration


bodograumann Mar 2, 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


34 changes: 15 additions & 19 deletions
modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1734,12 +1734,23 @@ public String getSchemaType(Schema schema) {
 }

 protected Schema<?> getSchemaItems(ArraySchema schema) {
 if (schema.getItems() != null) {
 return schema.getItems();
 } else {
 Schema<?> items = schema.getItems();
 if (items == null) {
 LOGGER.error("Undefined array inner type for `{}`. Default to String.", schema.getName());
 return new StringSchema().description("TODO default missing array inner type to string");
 items = new StringSchema().description("TODO default missing array inner type to string");
 schema.setItems(items);
 }
 return items;
 }

 protected Schema<?> getSchemaAdditionalProperties(Schema schema) {
 Schema<?> inner = ModelUtils.getAdditionalProperties(schema);
 if (inner == null) {
 LOGGER.error("`{}` (map property) does not have a proper inner type defined. Default to type:string", schema.getName());
 inner = new StringSchema().description("TODO default missing map inner type to string");
 schema.setAdditionalProperties(inner);
 }
 return inner;
 }

 /**
Expand DownExpand Up@@ -2534,9 +2545,6 @@ public CodegenProperty fromProperty(String name, Schema p) {
 // default to string if inner item is undefined
 ArraySchema arraySchema = (ArraySchema) p;
 Schema innerSchema = ModelUtils.unaliasSchema(this.openAPI, getSchemaItems(arraySchema), importMapping);
 if (arraySchema.getItems() == null) {
 arraySchema.setItems(innerSchema);
 }
 } else if (ModelUtils.isMapSchema(p)) {
 Schema innerSchema = ModelUtils.unaliasSchema(this.openAPI, ModelUtils.getAdditionalProperties(p),
 importMapping);
Expand DownExpand Up@@ -2616,9 +2624,6 @@ public CodegenProperty fromProperty(String name, Schema p) {
 }
 ArraySchema arraySchema = (ArraySchema) p;
 Schema innerSchema = ModelUtils.unaliasSchema(this.openAPI, getSchemaItems(arraySchema), importMapping);
 if (arraySchema.getItems() == null) {
 arraySchema.setItems(innerSchema);
 }
 CodegenProperty cp = fromProperty(itemName, innerSchema);
 updatePropertyForArray(property, cp);
 } else if (ModelUtils.isMapSchema(p)) {
Expand DownExpand Up@@ -3499,9 +3504,6 @@ public CodegenParameter fromParameter(Parameter parameter, Set<String> imports)
 if (ModelUtils.isArraySchema(parameterSchema)) { // for array parameter
 final ArraySchema arraySchema = (ArraySchema) parameterSchema;
 Schema inner = getSchemaItems(arraySchema);
 if (arraySchema.getItems() == null) {
 arraySchema.setItems(inner);
 }

 collectionFormat = getCollectionFormat(parameter);
 // default to csv:
Expand DownExpand Up@@ -5098,9 +5100,6 @@ public List<CodegenParameter> fromRequestBodyToFormParameters(RequestBody body,
 if (ModelUtils.isArraySchema(s)) {
 final ArraySchema arraySchema = (ArraySchema) s;
 Schema inner = getSchemaItems(arraySchema);
 if (arraySchema.getItems() == null) {
 arraySchema.setItems(inner);
 }

 codegenParameter = fromFormProperty(entry.getKey(), inner, imports);
 CodegenProperty codegenProperty = fromProperty("inner", inner);
Expand DownExpand Up@@ -5300,9 +5299,6 @@ public CodegenParameter fromRequestBody(RequestBody body, Set<String> imports, S
 } else if (ModelUtils.isArraySchema(schema)) {
 final ArraySchema arraySchema = (ArraySchema) schema;
 Schema inner = getSchemaItems(arraySchema);
 if (arraySchema.getItems() == null) {
 arraySchema.setItems(inner);
 }
 CodegenProperty codegenProperty = fromProperty("property", arraySchema);
 imports.add(codegenProperty.baseType);
 CodegenProperty innerCp = codegenProperty;
Expand Down

7 changes: 1 addition & 6 deletions
...enapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractJavaCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -740,12 +740,7 @@ public String getTypeDeclaration(Schema p) {
 Schema<?> items = getSchemaItems((ArraySchema) p);
 return getSchemaType(p) + "<" + getTypeDeclaration(ModelUtils.unaliasSchema(this.openAPI, items)) + ">";
 } else if (ModelUtils.isMapSchema(p)) {
 Schema inner = ModelUtils.getAdditionalProperties(p);
 if (inner == null) {
 LOGGER.error("`{}` (map property) does not have a proper inner type defined. Default to type:string", p.getName());
 inner = new StringSchema().description("TODO default missing map inner type to string");
 p.setAdditionalProperties(inner);
 }
 Schema<?> inner = getSchemaAdditionalProperties(p);
 return getSchemaType(p) + "<String, " + getTypeDeclaration(ModelUtils.unaliasSchema(this.openAPI, inner)) + ">";
 }
 return super.getTypeDeclaration(p);
Expand Down

9 changes: 4 additions & 5 deletions
...tor/src/main/java/org/openapitools/codegen/languages/AbstractTypeScriptClientCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -378,13 +378,12 @@ public String toModelFilename(String name) {
 @Override
 public String getTypeDeclaration(Schema p) {
 if (ModelUtils.isArraySchema(p)) {
 ArraySchema ap = (ArraySchema) p;
 Schema inner = ap.getItems();
 return getSchemaType(p) + "<" + getTypeDeclaration(inner) + ">";
 Schema<?> items = getSchemaItems((ArraySchema) p);
 return getSchemaType(p) + "<" + getTypeDeclaration(ModelUtils.unaliasSchema(this.openAPI, items)) + ">";
 } else if (ModelUtils.isMapSchema(p)) {
 Schema inner = ModelUtils.getAdditionalProperties(p);
 Schema<?> inner = getSchemaAdditionalProperties(p);
 String nullSafeSuffix = getNullSafeAdditionalProps() ? " | undefined" : "";
 return "{ [key: string]: " + getTypeDeclaration(inner) + nullSafeSuffix + "; }";
 return "{ [key: string]: " + getTypeDeclaration(ModelUtils.unaliasSchema(this.openAPI, inner)) + nullSafeSuffix + "; }";
 } else if (ModelUtils.isFileSchema(p)) {
 return "any";
 } else if (ModelUtils.isBinarySchema(p)) {
Expand Down

4 changes: 3 additions & 1 deletion
...nerator/src/main/java/org/openapitools/codegen/languages/TypeScriptRxjsClientCodegen.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -107,7 +107,9 @@ public boolean isDataTypeFile(final String dataType) {

 @Override
 public String getTypeDeclaration(Schema p) {
 if (ModelUtils.isBinarySchema(p)) {
 if (ModelUtils.isFileSchema(p)) {
 return "Blob";
 } else if (ModelUtils.isBinarySchema(p)) {
 return "Blob";
 }
 return super.getTypeDeclaration(p);
Expand Down

33 changes: 33 additions & 0 deletions
...test/java/org/openapitools/codegen/typescript/fetch/TypeScriptFetchClientCodegenTest.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
package org.openapitools.codegen.typescript.fetch;

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.media.*;
import org.openapitools.codegen.CodegenConstants;
import org.openapitools.codegen.TestUtils;
import org.openapitools.codegen.languages.TypeScriptFetchClientCodegen;
import org.openapitools.codegen.utils.ModelUtils;
import org.testng.Assert;
import org.testng.annotations.Test;

Expand DownExpand Up@@ -69,4 +71,35 @@ public void toVarName() {
 Assert.assertEquals(codegen.toVarName("valid_var"), "valid_var");
 }

 @Test
 public void getTypeDeclarationTest() {
 Schema<?> childSchema = new ArraySchema().items(new StringSchema());

 OpenAPI api = TestUtils.createOpenAPI();
 api.getComponents().addSchemas("Child", childSchema);

 TypeScriptFetchClientCodegen codegen = new TypeScriptFetchClientCodegen();
 codegen.setOpenAPI(api);

 // Cf. issue #4968: Array of Alias of Array
 Schema<?> parentSchema = new ArraySchema().items(
 new Schema().$ref("#/components/schemas/Child")
 );

 ModelUtils.setGenerateAliasAsModel(false);
 Assert.assertEquals(codegen.getTypeDeclaration(parentSchema), "Array<Array<string>>");

 ModelUtils.setGenerateAliasAsModel(true);
 Assert.assertEquals(codegen.getTypeDeclaration(parentSchema), "Array<Child>");

 // Same for Map
 parentSchema = new MapSchema().additionalProperties(new Schema().$ref("#/components/schemas/Child"));

 ModelUtils.setGenerateAliasAsModel(false);
 Assert.assertEquals(codegen.getTypeDeclaration(parentSchema), "{ [key: string]: Array<string>; }");

 ModelUtils.setGenerateAliasAsModel(true);
 Assert.assertEquals(codegen.getTypeDeclaration(parentSchema), "{ [key: string]: Child; }");
 }

}