Skip to content

[resttemplate] always use @JacksonXmlElementWrapper and read xml data from referenced schema, updated #15115

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
merged 3 commits into from
Jun 9, 2023
Merged

[resttemplate] always use @JacksonXmlElementWrapper and read xml data from referenced schema, updated #15115

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cf713a9
always use @JacksonXmlElementWrapper and read xml data from reference…
martin-mfg Apr 3, 2023
0a7ed03
run generate-samples.sh
martin-mfg Apr 3, 2023
fa82fea
suggestion: remove comment with empty name
martin-mfg Jun 8, 2023
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
40 changes: 26 additions & 14 deletions modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3870,14 +3870,6 @@ public CodegenProperty fromProperty(String name, Schema p, boolean required, boo
property.isNullable = p.getNullable();
}

if (p.getXml() != null) {
if (p.getXml().getAttribute() != null) {
property.isXmlAttribute = p.getXml().getAttribute();
}
property.xmlPrefix = p.getXml().getPrefix();
property.xmlName = p.getXml().getName();
property.xmlNamespace = p.getXml().getNamespace();
}
if (p.getExtensions() != null && !p.getExtensions().isEmpty()) {
property.getVendorExtensions().putAll(p.getExtensions());
} else if (p.get$ref() != null) {
Expand Down Expand Up @@ -3927,6 +3919,32 @@ public CodegenProperty fromProperty(String name, Schema p, boolean required, boo
property.isNullable = (Boolean) referencedSchema.getExtensions().get("x-nullable");
}

final XML referencedSchemaXml = referencedSchema.getXml();

if (referencedSchemaXml != null) {
property.xmlName = referencedSchemaXml.getName();
property.xmlNamespace = referencedSchemaXml.getNamespace();
property.xmlPrefix = referencedSchemaXml.getPrefix();
if (referencedSchemaXml.getAttribute() != null) {
property.isXmlAttribute = referencedSchemaXml.getAttribute();
}
if (referencedSchemaXml.getWrapped() != null) {
property.isXmlWrapped = referencedSchemaXml.getWrapped();
}
}

if (p.getXml() != null) {
if (p.getXml().getAttribute() != null) {
property.isXmlAttribute = p.getXml().getAttribute();
}
if (p.getXml().getWrapped() != null) {
property.isXmlWrapped = p.getXml().getWrapped();
}
property.xmlPrefix = p.getXml().getPrefix();
property.xmlName = p.getXml().getName();
property.xmlNamespace = p.getXml().getNamespace();
}

Copy link
Member

@wing328 wing328 Jun 8, 2023

Choose a reason for hiding this comment

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

cc @OpenAPITools/generator-core-team

property.dataType = getTypeDeclaration(p);
property.dataFormat = p.getFormat();
property.baseType = getSchemaType(p);
Expand Down Expand Up @@ -3961,12 +3979,6 @@ public CodegenProperty fromProperty(String name, Schema p, boolean required, boo
property.containerType = "array";
}
property.baseType = getSchemaType(p);
if (p.getXml() != null) {
property.isXmlWrapped = p.getXml().getWrapped() != null && p.getXml().getWrapped();
property.xmlPrefix = p.getXml().getPrefix();
property.xmlNamespace = p.getXml().getNamespace();
property.xmlName = p.getXml().getName();
}

// handle inner property
String itemName = getItemsName(p, name);
Expand Down
7 changes: 3 additions & 4 deletions modules/openapi-generator/src/main/resources/Java/jackson_annotations.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,8 @@
@JacksonXmlProperty({{#isXmlAttribute}}isAttribute = true, {{/isXmlAttribute}}{{#xmlNamespace}}namespace="{{.}}", {{/xmlNamespace}}localName = "{{xmlName}}{{^xmlName}}{{baseName}}{{/xmlName}}")
{{/isContainer}}
{{#isContainer}}
{{#isXmlWrapped}}
// items.xmlName={{items.xmlName}}
@JacksonXmlElementWrapper(useWrapping = {{isXmlWrapped}}, {{#xmlNamespace}}namespace="{{.}}", {{/xmlNamespace}}localName = "{{#items.xmlName}}{{items.xmlName}}{{/items.xmlName}}{{^items.xmlName}}{{items.baseName}}{{/items.xmlName}}")
{{/isXmlWrapped}}
// xmlName={{xmlName}}
@JacksonXmlProperty({{#xmlNamespace}}namespace="{{.}}", {{/xmlNamespace}}localName = "{{#xmlName}}{{xmlName}}{{/xmlName}}{{^xmlName}}{{#xmlName}}{{xmlName}}{{/xmlName}}{{^xmlName}}{{baseName}}{{/xmlName}}{{/xmlName}}")
@JacksonXmlElementWrapper(useWrapping = {{isXmlWrapped}}{{#xmlNamespace}}, namespace="{{.}}"{{/xmlNamespace}}{{#isXmlWrapped}}, localName = "{{#xmlName}}{{xmlName}}{{/xmlName}}{{^xmlName}}{{baseName}}{{/xmlName}}"{{/isXmlWrapped}})
{{/isContainer}}
{{/withXml}}
48 changes: 48 additions & 0 deletions ...mplate-withXml/src/main/java/org/openapitools/client/model/AdditionalPropertiesClass.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,9 @@ public AdditionalPropertiesClass putMapStringItem(String key, String mapStringIt
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_MAP_STRING)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
// xmlName=
@JacksonXmlProperty(localName = "map_string")
@JacksonXmlElementWrapper(useWrapping = false)

public Map<String, String> getMapString() {
return mapString;
Expand All @@ -152,6 +155,9 @@ public Map<String, String> getMapString() {

@JsonProperty(JSON_PROPERTY_MAP_STRING)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
// xmlName=
@JacksonXmlProperty(localName = "map_string")
@JacksonXmlElementWrapper(useWrapping = false)
public void setMapString(Map<String, String> mapString) {
this.mapString = mapString;
}
Expand All @@ -178,6 +184,9 @@ public AdditionalPropertiesClass putMapNumberItem(String key, BigDecimal mapNumb
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_MAP_NUMBER)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
// xmlName=
@JacksonXmlProperty(localName = "map_number")
@JacksonXmlElementWrapper(useWrapping = false)

public Map<String, BigDecimal> getMapNumber() {
return mapNumber;
Expand All @@ -186,6 +195,9 @@ public Map<String, BigDecimal> getMapNumber() {

@JsonProperty(JSON_PROPERTY_MAP_NUMBER)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
// xmlName=
@JacksonXmlProperty(localName = "map_number")
@JacksonXmlElementWrapper(useWrapping = false)
public void setMapNumber(Map<String, BigDecimal> mapNumber) {
this.mapNumber = mapNumber;
}
Expand All @@ -212,6 +224,9 @@ public AdditionalPropertiesClass putMapIntegerItem(String key, Integer mapIntege
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_MAP_INTEGER)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
// xmlName=
@JacksonXmlProperty(localName = "map_integer")
@JacksonXmlElementWrapper(useWrapping = false)

public Map<String, Integer> getMapInteger() {
return mapInteger;
Expand All @@ -220,6 +235,9 @@ public Map<String, Integer> getMapInteger() {

@JsonProperty(JSON_PROPERTY_MAP_INTEGER)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
// xmlName=
@JacksonXmlProperty(localName = "map_integer")
@JacksonXmlElementWrapper(useWrapping = false)
public void setMapInteger(Map<String, Integer> mapInteger) {
this.mapInteger = mapInteger;
}
Expand All @@ -246,6 +264,9 @@ public AdditionalPropertiesClass putMapBooleanItem(String key, Boolean mapBoolea
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_MAP_BOOLEAN)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
// xmlName=
@JacksonXmlProperty(localName = "map_boolean")
@JacksonXmlElementWrapper(useWrapping = false)

public Map<String, Boolean> getMapBoolean() {
return mapBoolean;
Expand All @@ -254,6 +275,9 @@ public Map<String, Boolean> getMapBoolean() {

@JsonProperty(JSON_PROPERTY_MAP_BOOLEAN)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
// xmlName=
@JacksonXmlProperty(localName = "map_boolean")
@JacksonXmlElementWrapper(useWrapping = false)
public void setMapBoolean(Map<String, Boolean> mapBoolean) {
this.mapBoolean = mapBoolean;
}
Expand All @@ -280,6 +304,9 @@ public AdditionalPropertiesClass putMapArrayIntegerItem(String key, List<Integer
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_MAP_ARRAY_INTEGER)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
// xmlName=
@JacksonXmlProperty(localName = "map_array_integer")
@JacksonXmlElementWrapper(useWrapping = false)

public Map<String, List<Integer>> getMapArrayInteger() {
return mapArrayInteger;
Expand All @@ -288,6 +315,9 @@ public Map<String, List<Integer>> getMapArrayInteger() {

@JsonProperty(JSON_PROPERTY_MAP_ARRAY_INTEGER)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
// xmlName=
@JacksonXmlProperty(localName = "map_array_integer")
@JacksonXmlElementWrapper(useWrapping = false)
public void setMapArrayInteger(Map<String, List<Integer>> mapArrayInteger) {
this.mapArrayInteger = mapArrayInteger;
}
Expand All @@ -314,6 +344,9 @@ public AdditionalPropertiesClass putMapArrayAnytypeItem(String key, List<Object>
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_MAP_ARRAY_ANYTYPE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
// xmlName=
@JacksonXmlProperty(localName = "map_array_anytype")
@JacksonXmlElementWrapper(useWrapping = false)

public Map<String, List<Object>> getMapArrayAnytype() {
return mapArrayAnytype;
Expand All @@ -322,6 +355,9 @@ public Map<String, List<Object>> getMapArrayAnytype() {

@JsonProperty(JSON_PROPERTY_MAP_ARRAY_ANYTYPE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
// xmlName=
@JacksonXmlProperty(localName = "map_array_anytype")
@JacksonXmlElementWrapper(useWrapping = false)
public void setMapArrayAnytype(Map<String, List<Object>> mapArrayAnytype) {
this.mapArrayAnytype = mapArrayAnytype;
}
Expand All @@ -348,6 +384,9 @@ public AdditionalPropertiesClass putMapMapStringItem(String key, Map<String, Str
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_MAP_MAP_STRING)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
// xmlName=
@JacksonXmlProperty(localName = "map_map_string")
@JacksonXmlElementWrapper(useWrapping = false)

public Map<String, Map<String, String>> getMapMapString() {
return mapMapString;
Expand All @@ -356,6 +395,9 @@ public Map<String, Map<String, String>> getMapMapString() {

@JsonProperty(JSON_PROPERTY_MAP_MAP_STRING)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
// xmlName=
@JacksonXmlProperty(localName = "map_map_string")
@JacksonXmlElementWrapper(useWrapping = false)
public void setMapMapString(Map<String, Map<String, String>> mapMapString) {
this.mapMapString = mapMapString;
}
Expand All @@ -382,6 +424,9 @@ public AdditionalPropertiesClass putMapMapAnytypeItem(String key, Map<String, Ob
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_MAP_MAP_ANYTYPE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
// xmlName=
@JacksonXmlProperty(localName = "map_map_anytype")
@JacksonXmlElementWrapper(useWrapping = false)

public Map<String, Map<String, Object>> getMapMapAnytype() {
return mapMapAnytype;
Expand All @@ -390,6 +435,9 @@ public Map<String, Map<String, Object>> getMapMapAnytype() {

@JsonProperty(JSON_PROPERTY_MAP_MAP_ANYTYPE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
// xmlName=
@JacksonXmlProperty(localName = "map_map_anytype")
@JacksonXmlElementWrapper(useWrapping = false)
public void setMapMapAnytype(Map<String, Map<String, Object>> mapMapAnytype) {
this.mapMapAnytype = mapMapAnytype;
}
Expand Down
6 changes: 6 additions & 0 deletions ...emplate-withXml/src/main/java/org/openapitools/client/model/ArrayOfArrayOfNumberOnly.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,9 @@ public ArrayOfArrayOfNumberOnly addArrayArrayNumberItem(List<BigDecimal> arrayAr
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_ARRAY_ARRAY_NUMBER)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
// xmlName=
@JacksonXmlProperty(localName = "ArrayArrayNumber")
@JacksonXmlElementWrapper(useWrapping = false)

public List<List<BigDecimal>> getArrayArrayNumber() {
return arrayArrayNumber;
Expand All @@ -80,6 +83,9 @@ public List<List<BigDecimal>> getArrayArrayNumber() {

@JsonProperty(JSON_PROPERTY_ARRAY_ARRAY_NUMBER)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
// xmlName=
@JacksonXmlProperty(localName = "ArrayArrayNumber")
@JacksonXmlElementWrapper(useWrapping = false)
public void setArrayArrayNumber(List<List<BigDecimal>> arrayArrayNumber) {
this.arrayArrayNumber = arrayArrayNumber;
}
Expand Down
6 changes: 6 additions & 0 deletions ...a/resttemplate-withXml/src/main/java/org/openapitools/client/model/ArrayOfNumberOnly.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,9 @@ public ArrayOfNumberOnly addArrayNumberItem(BigDecimal arrayNumberItem) {
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_ARRAY_NUMBER)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
// xmlName=
@JacksonXmlProperty(localName = "ArrayNumber")
@JacksonXmlElementWrapper(useWrapping = false)

public List<BigDecimal> getArrayNumber() {
return arrayNumber;
Expand All @@ -80,6 +83,9 @@ public List<BigDecimal> getArrayNumber() {

@JsonProperty(JSON_PROPERTY_ARRAY_NUMBER)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
// xmlName=
@JacksonXmlProperty(localName = "ArrayNumber")
@JacksonXmlElementWrapper(useWrapping = false)
public void setArrayNumber(List<BigDecimal> arrayNumber) {
this.arrayNumber = arrayNumber;
}
Expand Down
18 changes: 18 additions & 0 deletions ...tore/java/resttemplate-withXml/src/main/java/org/openapitools/client/model/ArrayTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,9 @@ public ArrayTest addArrayOfStringItem(String arrayOfStringItem) {
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_ARRAY_OF_STRING)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
// xmlName=
@JacksonXmlProperty(localName = "array_of_string")
@JacksonXmlElementWrapper(useWrapping = false)

public List<String> getArrayOfString() {
return arrayOfString;
Expand All @@ -96,6 +99,9 @@ public List<String> getArrayOfString() {

@JsonProperty(JSON_PROPERTY_ARRAY_OF_STRING)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
// xmlName=
@JacksonXmlProperty(localName = "array_of_string")
@JacksonXmlElementWrapper(useWrapping = false)
public void setArrayOfString(List<String> arrayOfString) {
this.arrayOfString = arrayOfString;
}
Expand All @@ -122,6 +128,9 @@ public ArrayTest addArrayArrayOfIntegerItem(List<Long> arrayArrayOfIntegerItem)
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_ARRAY_ARRAY_OF_INTEGER)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
// xmlName=
@JacksonXmlProperty(localName = "array_array_of_integer")
@JacksonXmlElementWrapper(useWrapping = false)

public List<List<Long>> getArrayArrayOfInteger() {
return arrayArrayOfInteger;
Expand All @@ -130,6 +139,9 @@ public List<List<Long>> getArrayArrayOfInteger() {

@JsonProperty(JSON_PROPERTY_ARRAY_ARRAY_OF_INTEGER)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
// xmlName=
@JacksonXmlProperty(localName = "array_array_of_integer")
@JacksonXmlElementWrapper(useWrapping = false)
public void setArrayArrayOfInteger(List<List<Long>> arrayArrayOfInteger) {
this.arrayArrayOfInteger = arrayArrayOfInteger;
}
Expand All @@ -156,6 +168,9 @@ public ArrayTest addArrayArrayOfModelItem(List<ReadOnlyFirst> arrayArrayOfModelI
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_ARRAY_ARRAY_OF_MODEL)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
// xmlName=
@JacksonXmlProperty(localName = "array_array_of_model")
@JacksonXmlElementWrapper(useWrapping = false)

public List<List<ReadOnlyFirst>> getArrayArrayOfModel() {
return arrayArrayOfModel;
Expand All @@ -164,6 +179,9 @@ public List<List<ReadOnlyFirst>> getArrayArrayOfModel() {

@JsonProperty(JSON_PROPERTY_ARRAY_ARRAY_OF_MODEL)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
// xmlName=
@JacksonXmlProperty(localName = "array_array_of_model")
@JacksonXmlElementWrapper(useWrapping = false)
public void setArrayArrayOfModel(List<List<ReadOnlyFirst>> arrayArrayOfModel) {
this.arrayArrayOfModel = arrayArrayOfModel;
}
Expand Down
6 changes: 6 additions & 0 deletions ...ore/java/resttemplate-withXml/src/main/java/org/openapitools/client/model/EnumArrays.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,9 @@ public EnumArrays addArrayEnumItem(ArrayEnumEnum arrayEnumItem) {
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_ARRAY_ENUM)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
// xmlName=
@JacksonXmlProperty(localName = "array_enum")
@JacksonXmlElementWrapper(useWrapping = false)

public List<ArrayEnumEnum> getArrayEnum() {
return arrayEnum;
Expand All @@ -190,6 +193,9 @@ public List<ArrayEnumEnum> getArrayEnum() {

@JsonProperty(JSON_PROPERTY_ARRAY_ENUM)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
// xmlName=
@JacksonXmlProperty(localName = "array_enum")
@JacksonXmlElementWrapper(useWrapping = false)
public void setArrayEnum(List<ArrayEnumEnum> arrayEnum) {
this.arrayEnum = arrayEnum;
}
Expand Down
6 changes: 6 additions & 0 deletions ...resttemplate-withXml/src/main/java/org/openapitools/client/model/FileSchemaTestClass.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,9 @@ public FileSchemaTestClass addFilesItem(ModelFile filesItem) {
@javax.annotation.Nullable
@JsonProperty(JSON_PROPERTY_FILES)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
// xmlName=
@JacksonXmlProperty(localName = "files")
@JacksonXmlElementWrapper(useWrapping = false)

public List<ModelFile> getFiles() {
return files;
Expand All @@ -113,6 +116,9 @@ public List<ModelFile> getFiles() {

@JsonProperty(JSON_PROPERTY_FILES)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
// xmlName=
@JacksonXmlProperty(localName = "files")
@JacksonXmlElementWrapper(useWrapping = false)
public void setFiles(List<ModelFile> files) {
this.files = files;
}
Expand Down
Loading