Skip to content
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

Jump to bottom

[Default] update isAdditionalPropertiesTrue tag to cover more types #16227

Merged
merged 6 commits into from
Aug 5, 2023
Merged

[Default] update isAdditionalPropertiesTrue tag to cover more types #16227

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0b10a62
enhance additional properties support
wing328 Aug 1, 2023
2dc4700
update samples
wing328 Aug 1, 2023
40042ca
update tests
wing328 Aug 1, 2023
1dace16
add more tests
wing328 Aug 2, 2023
f029553
update samples
wing328 Aug 2, 2023
38a15ff
fix samples
wing328 Aug 2, 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
7 changes: 6 additions & 1 deletion modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenModel.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,10 @@ public class CodegenModel implements IJsonSchemaValidationProperties {
public String additionalPropertiesType;

/**
* True if additionalProperties is set to true (boolean value)
* True if additionalProperties is set to true (boolean value), any type, free form object, etc
*
* TODO: we may rename this to isAdditionalPropertiesEnabled or something
* else to avoid confusions
*/
public boolean isAdditionalPropertiesTrue;

Expand Down Expand Up @@ -1088,6 +1091,7 @@ public boolean equals(Object o) {
Objects.equals(externalDocumentation, that.externalDocumentation) &&
Objects.equals(vendorExtensions, that.vendorExtensions) &&
Objects.equals(additionalPropertiesType, that.additionalPropertiesType) &&
Objects.equals(isAdditionalPropertiesTrue, that.isAdditionalPropertiesTrue) &&
Objects.equals(getMaxProperties(), that.getMaxProperties()) &&
Objects.equals(getMinProperties(), that.getMinProperties()) &&
Objects.equals(getMaxItems(), that.getMaxItems()) &&
Expand Down Expand Up @@ -1193,6 +1197,7 @@ public String toString() {
sb.append(", externalDocumentation=").append(externalDocumentation);
sb.append(", vendorExtensions=").append(vendorExtensions);
sb.append(", additionalPropertiesType='").append(additionalPropertiesType).append('\'');
sb.append(", isAdditionalPropertiesTrue='").append(isAdditionalPropertiesTrue).append('\'');
sb.append(", maxProperties=").append(maxProperties);
sb.append(", minProperties=").append(minProperties);
sb.append(", uniqueItems=").append(uniqueItems);
Expand Down
10 changes: 6 additions & 4 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 @@ -3167,6 +3167,9 @@ protected void setAddProps(Schema schema, IJsonSchemaValidationProperties proper
// if we are trying to set additionalProperties on an empty schema stop recursing
return;
}
// Note: This flag is set to true if additioanl properties
// is set (any type, free form object, boolean true, string, etc).
// The variable name may be renamed later to avoid confusion.
boolean additionalPropertiesIsAnyType = false;
CodegenModel m = null;
if (property instanceof CodegenModel) {
Expand All @@ -3187,15 +3190,14 @@ protected void setAddProps(Schema schema, IJsonSchemaValidationProperties proper
additionalPropertiesIsAnyType = true;
}
} else {
// if additioanl properties is set (e.g. free form object, any type, string, etc)
addPropProp = fromProperty(getAdditionalPropertiesName(), (Schema) schema.getAdditionalProperties(), false);
if (ModelUtils.isAnyType((Schema) schema.getAdditionalProperties())) {
additionalPropertiesIsAnyType = true;
}
additionalPropertiesIsAnyType = true;
}
if (additionalPropertiesIsAnyType) {
property.setAdditionalPropertiesIsAnyType(true);
}
if (m != null && isAdditionalPropertiesTrue) {
if (m != null && (isAdditionalPropertiesTrue || additionalPropertiesIsAnyType)) {
m.isAdditionalPropertiesTrue = true;
}
if (ModelUtils.isComposedSchema(schema) && !supportsAdditionalPropertiesWithComposedSchema) {
Expand Down
14 changes: 7 additions & 7 deletions modules/openapi-generator/src/test/java/org/openapitools/codegen/DefaultCodegenTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2616,7 +2616,7 @@ public void testAdditionalPropertiesPresentInModels() {
cm = codegen.fromModel(modelName, sc);
CodegenProperty stringCp = codegen.fromProperty("additional_properties", new Schema().type("string"));
assertEquals(cm.getAdditionalProperties(), stringCp);
assertFalse(cm.getAdditionalPropertiesIsAnyType());
assertTrue(cm.getAdditionalPropertiesIsAnyType());
}

@Test
Expand Down Expand Up @@ -2656,7 +2656,7 @@ public void testAdditionalPropertiesPresentInModelProperties() {
assertFalse(mapWithAddPropsFalse.getAdditionalPropertiesIsAnyType());
mapWithAddPropsSchema = cm.getVars().get(3);
assertEquals(mapWithAddPropsSchema.getAdditionalProperties(), stringCp);
assertFalse(mapWithAddPropsSchema.getAdditionalPropertiesIsAnyType());
assertTrue(mapWithAddPropsSchema.getAdditionalPropertiesIsAnyType());

modelName = "ObjectModelWithAddPropsInProps";
sc = openAPI.getComponents().getSchemas().get(modelName);
Expand All @@ -2672,7 +2672,7 @@ public void testAdditionalPropertiesPresentInModelProperties() {
assertFalse(mapWithAddPropsFalse.getAdditionalPropertiesIsAnyType());
mapWithAddPropsSchema = cm.getVars().get(3);
assertEquals(mapWithAddPropsSchema.getAdditionalProperties(), stringCp);
assertFalse(mapWithAddPropsSchema.getAdditionalPropertiesIsAnyType());
assertTrue(mapWithAddPropsSchema.getAdditionalPropertiesIsAnyType());

if (isGenerateAliasAsModel) { // restore the setting
GlobalSettings.setProperty("generateAliasAsModel", "true");
Expand Down Expand Up @@ -2717,7 +2717,7 @@ public void testAdditionalPropertiesPresentInParameters() {
assertFalse(mapWithAddPropsFalse.getAdditionalPropertiesIsAnyType());
mapWithAddPropsSchema = co.queryParams.get(3);
assertEquals(mapWithAddPropsSchema.getAdditionalProperties(), stringCp);
assertFalse(mapWithAddPropsSchema.getAdditionalPropertiesIsAnyType());
assertTrue(mapWithAddPropsSchema.getAdditionalPropertiesIsAnyType());

path = "/additional_properties/";
operation = openAPI.getPaths().get(path).getPost();
Expand All @@ -2733,7 +2733,7 @@ public void testAdditionalPropertiesPresentInParameters() {
assertFalse(mapWithAddPropsFalse.getAdditionalPropertiesIsAnyType());
mapWithAddPropsSchema = co.queryParams.get(3);
assertEquals(mapWithAddPropsSchema.getAdditionalProperties(), stringCp);
assertFalse(mapWithAddPropsSchema.getAdditionalPropertiesIsAnyType());
assertTrue(mapWithAddPropsSchema.getAdditionalPropertiesIsAnyType());

if (isGenerateAliasAsModel) { // restore the setting
GlobalSettings.setProperty("generateAliasAsModel", "true");
Expand Down Expand Up @@ -2778,7 +2778,7 @@ public void testAdditionalPropertiesPresentInResponses() {
assertFalse(mapWithAddPropsFalse.getAdditionalPropertiesIsAnyType());
mapWithAddPropsSchema = co.responses.get(3);
assertEquals(mapWithAddPropsSchema.getAdditionalProperties(), stringCp);
assertFalse(mapWithAddPropsSchema.getAdditionalPropertiesIsAnyType());
assertTrue(mapWithAddPropsSchema.getAdditionalPropertiesIsAnyType());

path = "/additional_properties/";
operation = openAPI.getPaths().get(path).getPost();
Expand All @@ -2794,7 +2794,7 @@ public void testAdditionalPropertiesPresentInResponses() {
assertFalse(mapWithAddPropsFalse.getAdditionalPropertiesIsAnyType());
mapWithAddPropsSchema = co.responses.get(3);
assertEquals(mapWithAddPropsSchema.getAdditionalProperties(), stringCp);
assertFalse(mapWithAddPropsSchema.getAdditionalPropertiesIsAnyType());
assertTrue(mapWithAddPropsSchema.getAdditionalPropertiesIsAnyType());

if (isGenerateAliasAsModel) { // restore the setting
GlobalSettings.setProperty("generateAliasAsModel", "true");
Expand Down
21 changes: 20 additions & 1 deletion ...erator/src/test/resources/3_0/python/petstore-with-fake-endpoints-models-for-testing.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2272,4 +2272,23 @@ components:
properties:
skill:
type: string

AdditionalPropertiesObject:
type: object
properties:
name:
type: string
additionalProperties:
type: object
AdditionalPropertiesAnyType:
type: object
properties:
name:
type: string
additionalProperties: {}
AdditionalPropertiesWithDescriptionOnly:
type: object
properties:
name:
type: string
additionalProperties:
description: This is what the additional property is
12 changes: 12 additions & 0 deletions ...store/csharp/OpenAPIClient-ConditionalSerialization/src/Org.OpenAPITools/Model/Drawing.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ public partial class Drawing : Dictionary<String, Fruit>, IEquatable<Drawing>, I
{
this._flagShapes = true;
}
this.AdditionalProperties = new Dictionary<string, object>();
}

/// <summary>
Expand Down Expand Up @@ -159,6 +160,12 @@ public bool ShouldSerializeShapes()
{
return _flagShapes;
}
/// <summary>
/// Gets or Sets additional properties
/// </summary>
[JsonExtensionData]
public IDictionary<string, object> AdditionalProperties { get; set; }

/// <summary>
/// Returns the string presentation of the object
/// </summary>
Expand All @@ -172,6 +179,7 @@ public override string ToString()
sb.Append(" ShapeOrNull: ").Append(ShapeOrNull).Append("\n");
sb.Append(" NullableShape: ").Append(NullableShape).Append("\n");
sb.Append(" Shapes: ").Append(Shapes).Append("\n");
sb.Append(" AdditionalProperties: ").Append(AdditionalProperties).Append("\n");
sb.Append("}\n");
return sb.ToString();
}
Expand Down Expand Up @@ -230,6 +238,10 @@ public override int GetHashCode()
{
hashCode = (hashCode * 59) + this.Shapes.GetHashCode();
}
if (this.AdditionalProperties != null)
{
hashCode = (hashCode * 59) + this.AdditionalProperties.GetHashCode();
}
return hashCode;
}
}
Expand Down
12 changes: 12 additions & 0 deletions ...csharp/OpenAPIClient-ConditionalSerialization/src/Org.OpenAPITools/Model/NullableClass.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ public partial class NullableClass : Dictionary<String, Object>, IEquatable<Null
{
this._flagObjectItemsNullable = true;
}
this.AdditionalProperties = new Dictionary<string, object>();
}

/// <summary>
Expand Down Expand Up @@ -400,6 +401,12 @@ public bool ShouldSerializeObjectItemsNullable()
{
return _flagObjectItemsNullable;
}
/// <summary>
/// Gets or Sets additional properties
/// </summary>
[JsonExtensionData]
public IDictionary<string, object> AdditionalProperties { get; set; }

/// <summary>
/// Returns the string presentation of the object
/// </summary>
Expand All @@ -421,6 +428,7 @@ public override string ToString()
sb.Append(" ObjectNullableProp: ").Append(ObjectNullableProp).Append("\n");
sb.Append(" ObjectAndItemsNullableProp: ").Append(ObjectAndItemsNullableProp).Append("\n");
sb.Append(" ObjectItemsNullable: ").Append(ObjectItemsNullable).Append("\n");
sb.Append(" AdditionalProperties: ").Append(AdditionalProperties).Append("\n");
sb.Append("}\n");
return sb.ToString();
}
Expand Down Expand Up @@ -511,6 +519,10 @@ public override int GetHashCode()
{
hashCode = (hashCode * 59) + this.ObjectItemsNullable.GetHashCode();
}
if (this.AdditionalProperties != null)
{
hashCode = (hashCode * 59) + this.AdditionalProperties.GetHashCode();
}
return hashCode;
}
}
Expand Down
7 changes: 7 additions & 0 deletions ...etstore/csharp/OpenAPIClient-generichost-net6.0-nrt/src/Org.OpenAPITools/Model/Drawing.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,12 @@ public Drawing(Shape mainShape, List<Shape> shapes, NullableShape? nullableShape
[JsonPropertyName("shapeOrNull")]
public ShapeOrNull? ShapeOrNull { get; set; }

/// <summary>
/// Gets or Sets additional properties
/// </summary>
[JsonExtensionData]
public Dictionary<string, JsonElement> AdditionalProperties { get; } = new Dictionary<string, JsonElement>();

/// <summary>
/// Returns the string presentation of the object
/// </summary>
Expand All @@ -86,6 +92,7 @@ public override string ToString()
sb.Append(" Shapes: ").Append(Shapes).Append("\n");
sb.Append(" NullableShape: ").Append(NullableShape).Append("\n");
sb.Append(" ShapeOrNull: ").Append(ShapeOrNull).Append("\n");
sb.Append(" AdditionalProperties: ").Append(AdditionalProperties).Append("\n");
sb.Append("}\n");
return sb.ToString();
}
Expand Down
7 changes: 7 additions & 0 deletions ...e/csharp/OpenAPIClient-generichost-net6.0-nrt/src/Org.OpenAPITools/Model/NullableClass.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,12 @@ public NullableClass(List<Object> arrayItemsNullable, Dictionary<string, Object>
[JsonPropertyName("string_prop")]
public string? StringProp { get; set; }

/// <summary>
/// Gets or Sets additional properties
/// </summary>
[JsonExtensionData]
public Dictionary<string, JsonElement> AdditionalProperties { get; } = new Dictionary<string, JsonElement>();

/// <summary>
/// Returns the string presentation of the object
/// </summary>
Expand All @@ -158,6 +164,7 @@ public override string ToString()
sb.Append(" ObjectAndItemsNullableProp: ").Append(ObjectAndItemsNullableProp).Append("\n");
sb.Append(" ObjectNullableProp: ").Append(ObjectNullableProp).Append("\n");
sb.Append(" StringProp: ").Append(StringProp).Append("\n");
sb.Append(" AdditionalProperties: ").Append(AdditionalProperties).Append("\n");
sb.Append("}\n");
return sb.ToString();
}
Expand Down
7 changes: 7 additions & 0 deletions ...nt/petstore/csharp/OpenAPIClient-generichost-net6.0/src/Org.OpenAPITools/Model/Drawing.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,12 @@ public Drawing(Shape mainShape, List<Shape> shapes, NullableShape nullableShape
[JsonPropertyName("shapeOrNull")]
public ShapeOrNull ShapeOrNull { get; set; }

/// <summary>
/// Gets or Sets additional properties
/// </summary>
[JsonExtensionData]
public Dictionary<string, JsonElement> AdditionalProperties { get; } = new Dictionary<string, JsonElement>();

/// <summary>
/// Returns the string presentation of the object
/// </summary>
Expand All @@ -84,6 +90,7 @@ public override string ToString()
sb.Append(" Shapes: ").Append(Shapes).Append("\n");
sb.Append(" NullableShape: ").Append(NullableShape).Append("\n");
sb.Append(" ShapeOrNull: ").Append(ShapeOrNull).Append("\n");
sb.Append(" AdditionalProperties: ").Append(AdditionalProperties).Append("\n");
sb.Append("}\n");
return sb.ToString();
}
Expand Down
7 changes: 7 additions & 0 deletions ...store/csharp/OpenAPIClient-generichost-net6.0/src/Org.OpenAPITools/Model/NullableClass.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,12 @@ public NullableClass(List<Object> arrayItemsNullable, Dictionary<string, Object>
[JsonPropertyName("string_prop")]
public string StringProp { get; set; }

/// <summary>
/// Gets or Sets additional properties
/// </summary>
[JsonExtensionData]
public Dictionary<string, JsonElement> AdditionalProperties { get; } = new Dictionary<string, JsonElement>();

/// <summary>
/// Returns the string presentation of the object
/// </summary>
Expand All @@ -156,6 +162,7 @@ public override string ToString()
sb.Append(" ObjectAndItemsNullableProp: ").Append(ObjectAndItemsNullableProp).Append("\n");
sb.Append(" ObjectNullableProp: ").Append(ObjectNullableProp).Append("\n");
sb.Append(" StringProp: ").Append(StringProp).Append("\n");
sb.Append(" AdditionalProperties: ").Append(AdditionalProperties).Append("\n");
sb.Append("}\n");
return sb.ToString();
}
Expand Down
7 changes: 7 additions & 0 deletions ...ore/csharp/OpenAPIClient-generichost-netstandard2.0/src/Org.OpenAPITools/Model/Drawing.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,12 @@ public Drawing(Shape mainShape, List<Shape> shapes, NullableShape nullableShape
[JsonPropertyName("shapeOrNull")]
public ShapeOrNull ShapeOrNull { get; set; }

/// <summary>
/// Gets or Sets additional properties
/// </summary>
[JsonExtensionData]
public Dictionary<string, JsonElement> AdditionalProperties { get; } = new Dictionary<string, JsonElement>();

/// <summary>
/// Returns the string presentation of the object
/// </summary>
Expand All @@ -84,6 +90,7 @@ public override string ToString()
sb.Append(" Shapes: ").Append(Shapes).Append("\n");
sb.Append(" NullableShape: ").Append(NullableShape).Append("\n");
sb.Append(" ShapeOrNull: ").Append(ShapeOrNull).Append("\n");
sb.Append(" AdditionalProperties: ").Append(AdditionalProperties).Append("\n");
sb.Append("}\n");
return sb.ToString();
}
Expand Down
7 changes: 7 additions & 0 deletions ...harp/OpenAPIClient-generichost-netstandard2.0/src/Org.OpenAPITools/Model/NullableClass.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,12 @@ public NullableClass(List<Object> arrayItemsNullable, Dictionary<string, Object>
[JsonPropertyName("string_prop")]
public string StringProp { get; set; }

/// <summary>
/// Gets or Sets additional properties
/// </summary>
[JsonExtensionData]
public Dictionary<string, JsonElement> AdditionalProperties { get; } = new Dictionary<string, JsonElement>();

/// <summary>
/// Returns the string presentation of the object
/// </summary>
Expand All @@ -156,6 +162,7 @@ public override string ToString()
sb.Append(" ObjectAndItemsNullableProp: ").Append(ObjectAndItemsNullableProp).Append("\n");
sb.Append(" ObjectNullableProp: ").Append(ObjectNullableProp).Append("\n");
sb.Append(" StringProp: ").Append(StringProp).Append("\n");
sb.Append(" AdditionalProperties: ").Append(AdditionalProperties).Append("\n");
sb.Append("}\n");
return sb.ToString();
}
Expand Down
12 changes: 12 additions & 0 deletions ...les/client/petstore/csharp/OpenAPIClient-httpclient/src/Org.OpenAPITools/Model/Drawing.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ public partial class Drawing : Dictionary<String, Fruit>, IEquatable<Drawing>, I
this.ShapeOrNull = shapeOrNull;
this.NullableShape = nullableShape;
this.Shapes = shapes;
this.AdditionalProperties = new Dictionary<string, object>();
}

/// <summary>
Expand All @@ -72,6 +73,12 @@ public partial class Drawing : Dictionary<String, Fruit>, IEquatable<Drawing>, I
[DataMember(Name = "shapes", EmitDefaultValue = false)]
public List<Shape> Shapes { get; set; }

/// <summary>
/// Gets or Sets additional properties
/// </summary>
[JsonExtensionData]
public IDictionary<string, object> AdditionalProperties { get; set; }

/// <summary>
/// Returns the string presentation of the object
/// </summary>
Expand All @@ -85,6 +92,7 @@ public override string ToString()
sb.Append(" ShapeOrNull: ").Append(ShapeOrNull).Append("\n");
sb.Append(" NullableShape: ").Append(NullableShape).Append("\n");
sb.Append(" Shapes: ").Append(Shapes).Append("\n");
sb.Append(" AdditionalProperties: ").Append(AdditionalProperties).Append("\n");
sb.Append("}\n");
return sb.ToString();
}
Expand Down Expand Up @@ -143,6 +151,10 @@ public override int GetHashCode()
{
hashCode = (hashCode * 59) + this.Shapes.GetHashCode();
}
if (this.AdditionalProperties != null)
{
hashCode = (hashCode * 59) + this.AdditionalProperties.GetHashCode();
}
return hashCode;
}
}
Expand Down
Loading
Loading