Add propertyNames and nameOnlyVars to Model and Property

Author: Sqh3rd

modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenModel.java

@@ -144,6 +144,8 @@ public class CodegenModel implements IJsonSchemaValidationProperties {
     @Getter @Setter
     public List<CodegenProperty> nonNullableVars = new ArrayList<>(); // a list of non-nullable properties
     @Getter @Setter
+    public List<String> nameOnlyVars = new ArrayList<>(); // Names of properties specified by propertyNames
+    @Getter @Setter
     public Map<String, Object> allowableValues;
 
     // Sorted sets of required parameters.
@@ -256,6 +258,7 @@ public class CodegenModel implements IJsonSchemaValidationProperties {
     private Number multipleOf;
     private CodegenProperty items;
     private CodegenProperty additionalProperties;
+    private CodegenProperty propertyNames;
     private boolean isModel;
     private boolean hasRequiredVars;
     private boolean hasDiscriminatorWithNonEmptyMapping;
@@ -634,6 +637,20 @@ public void setAdditionalProperties(CodegenProperty additionalProperties) {
         this.additionalProperties = additionalProperties;
     }
 
+    @Override
+    public CodegenProperty getPropertyNames() {
+        return propertyNames;
+    }
+
+    @Override
+    public void setPropertyNames(CodegenProperty propertyNames) {
+        this.propertyNames = propertyNames;
+        if (!propertyNames.getIsEnum()) {
+            return;
+        }
+        this.nameOnlyVars.addAll(propertyNames.get_enum());
+    }
+
     @Override
     public boolean getHasValidation() {
         return hasValidation;
@@ -970,6 +987,7 @@ public boolean equals(Object o) {
                 Objects.equals(readOnlyVars, that.readOnlyVars) &&
                 Objects.equals(readWriteVars, that.readWriteVars) &&
                 Objects.equals(parentVars, that.parentVars) &&
+                Objects.equals(nameOnlyVars, that.nameOnlyVars) &&
                 Objects.equals(allowableValues, that.allowableValues) &&
                 Objects.equals(mandatory, that.mandatory) &&
                 Objects.equals(allMandatory, that.allMandatory) &&
@@ -978,6 +996,7 @@ public boolean equals(Object o) {
                 Objects.equals(vendorExtensions, that.vendorExtensions) &&
                 Objects.equals(additionalPropertiesType, that.additionalPropertiesType) &&
                 Objects.equals(isAdditionalPropertiesTrue, that.isAdditionalPropertiesTrue) &&
+                Objects.equals(propertyNames, that.propertyNames) &&
                 Objects.equals(getMaxProperties(), that.getMaxProperties()) &&
                 Objects.equals(getMinProperties(), that.getMinProperties()) &&
                 Objects.equals(getMaxItems(), that.getMaxItems()) &&
@@ -1002,10 +1021,10 @@ public int hashCode() {
                 getArrayModelType(), isAlias, isString, isInteger, isLong, isNumber, isNumeric, isFloat, isDouble,
                 isDate, isDateTime, isNull, hasValidation, isShort, isUnboundedInteger, isBoolean,
                 getVars(), getAllVars(), getNonNullableVars(), getRequiredVars(), getOptionalVars(), getReadOnlyVars(), getReadWriteVars(),
-                getParentVars(), getAllowableValues(), getMandatory(), getAllMandatory(), getImports(), hasVars,
+                getParentVars(), getNameOnlyVars(), getAllowableValues(), getMandatory(), getAllMandatory(), getImports(), hasVars,
                 isEmptyVars(), hasMoreModels, hasEnums, isEnum, isNullable, hasRequired, hasOptional, isArray,
                 hasChildren, isMap, isOptional, isDeprecated, hasReadOnly, hasOnlyReadOnly, getExternalDocumentation(), getVendorExtensions(),
-                getAdditionalPropertiesType(), getMaxProperties(), getMinProperties(), getUniqueItems(), getMaxItems(),
+                getAdditionalPropertiesType(), getPropertyNames(), getMaxProperties(), getMinProperties(), getUniqueItems(), getMaxItems(),
                 getMinItems(), getMaxLength(), getMinLength(), getExclusiveMinimum(), getExclusiveMaximum(), getMinimum(),
                 getMaximum(), getPattern(), getMultipleOf(), getItems(), getAdditionalProperties(), getIsModel(),
                 getAdditionalPropertiesIsAnyType(), hasDiscriminatorWithNonEmptyMapping,

modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenParameter.java

@@ -61,6 +61,7 @@ public class CodegenParameter implements IJsonSchemaValidationProperties {
     public Map<String, Object> allowableValues;
     public CodegenProperty items;
     public CodegenProperty additionalProperties;
+    public CodegenProperty propertyNames;
     public List<CodegenProperty> vars = new ArrayList<CodegenProperty>(); // all properties (without parent's properties)
     public List<CodegenProperty> requiredVars = new ArrayList<CodegenProperty>();
     public CodegenProperty mostInnerItems;
@@ -858,6 +859,16 @@ public void setAdditionalProperties(CodegenProperty additionalProperties) {
         this.additionalProperties = additionalProperties;
     }
 
+    @Override
+    public CodegenProperty getPropertyNames() {
+        return propertyNames;
+    }
+
+    @Override
+    public void setPropertyNames(CodegenProperty propertyNames) {
+        this.propertyNames = propertyNames;
+    }
+
     @Override
     public List<CodegenProperty> getVars() {
         return vars;

modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenProperty.java

@@ -196,8 +196,10 @@ public class CodegenProperty implements Cloneable, IJsonSchemaValidationProperti
     // the undeclared properties.
     public CodegenProperty items;
     public CodegenProperty additionalProperties;
+    public CodegenProperty propertyNames;
     public List<CodegenProperty> vars = new ArrayList<CodegenProperty>(); // all properties (without parent's properties)
     public List<CodegenProperty> requiredVars = new ArrayList<>();
+    public List<String> nameOnlyVars = new ArrayList<>();
     public CodegenProperty mostInnerItems;
     @Getter @Setter
     public Map<String, Object> vendorExtensions = new HashMap<String, Object>();
@@ -465,6 +467,20 @@ public void setAdditionalProperties(CodegenProperty additionalProperties) {
         this.additionalProperties = additionalProperties;
     }
 
+    @Override
+    public CodegenProperty getPropertyNames() {
+        return propertyNames;
+    }
+
+    @Override
+    public void setPropertyNames(CodegenProperty propertyNames) {
+        this.propertyNames = propertyNames;
+        if (!propertyNames.getIsEnum()) {
+            return;
+        }
+        nameOnlyVars.addAll(propertyNames.get_enum());
+    }
+
     @Override
     public boolean getIsModel() {
         return isModel;
@@ -1190,6 +1206,7 @@ public boolean equals(Object o) {
                 Objects.equals(allowableValues, that.allowableValues) &&
                 Objects.equals(items, that.items) &&
                 Objects.equals(additionalProperties, that.additionalProperties) &&
+                Objects.equals(propertyNames, that.propertyNames) &&
                 Objects.equals(vars, that.vars) &&
                 Objects.equals(requiredVars, that.requiredVars) &&
                 Objects.equals(mostInnerItems, that.mostInnerItems) &&
@@ -1220,7 +1237,7 @@ public int hashCode() {
                 isBoolean, isDate, isDateTime, isUuid, isUri, isEmail, isPassword, isFreeFormObject,
                 isArray, isMap, isOptional, isEnum, isInnerEnum, isEnumRef, isAnyType, isReadOnly, isWriteOnly, isNullable, isShort,
                 isUnboundedInteger, isSelfReference, isCircularReference, isDiscriminator, isNew, isOverridden, _enum,
-                allowableValues, items, mostInnerItems, additionalProperties, vars, requiredVars,
+                allowableValues, items, mostInnerItems, additionalProperties, propertyNames, vars, requiredVars,
                 vendorExtensions, hasValidation, isInherited, discriminatorValue, nameInPascalCase, nameInCamelCase,
                 nameInSnakeCase, enumName, maxItems, minItems, isXmlAttribute, xmlPrefix, xmlName,
                 xmlNamespace, isXmlWrapped, isNull, isVoid, additionalPropertiesIsAnyType, hasVars, hasRequired,

modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenResponse.java

@@ -91,6 +91,7 @@ public class CodegenResponse implements IJsonSchemaValidationProperties {
     public Number multipleOf;
     public CodegenProperty items;
     public CodegenProperty additionalProperties;
+    public CodegenProperty propertyNames;
     public List<CodegenProperty> vars = new ArrayList<CodegenProperty>(); // all properties (without parent's properties)
     public List<CodegenProperty> requiredVars = new ArrayList<CodegenProperty>();
     private boolean hasValidation;
@@ -531,6 +532,16 @@ public void setAdditionalProperties(CodegenProperty additionalProperties) {
         this.additionalProperties = additionalProperties;
     }
 
+    @Override
+    public CodegenProperty getPropertyNames() {
+        return propertyNames;
+    }
+
+    @Override
+    public void setPropertyNames(CodegenProperty propertyNames) {
+        this.propertyNames = propertyNames;
+    }
+
     @Override
     public List<CodegenProperty> getVars() {
         return vars;

modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java

@@ -2923,6 +2923,7 @@ protected void updateModelForObject(CodegenModel m, Schema schema) {
         }
         // process 'additionalProperties'
         setAddProps(schema, m);
+        setPropNames(schema, m);
         addRequiredVarsMap(schema, m);
     }
 
@@ -2944,6 +2945,7 @@ protected void updateModelForAnyType(CodegenModel m, Schema schema) {
         }
         // process 'additionalProperties'
         setAddProps(schema, m);
+        setPropNames(schema, m);
         addRequiredVarsMap(schema, m);
     }
 
@@ -3260,6 +3262,18 @@ protected void SortModelPropertiesByRequiredFlag(CodegenModel model) {
         Collections.sort(model.allVars, comparator);
     }
 
+    protected void setPropNames(Schema schema, IJsonSchemaValidationProperties property) {
+        if (schema.equals(new Schema())) {
+            return;
+        }
+
+        if (schema.getPropertyNames() == null) {
+            return;
+        }
+        CodegenProperty propNamesProp = fromProperty(getPropertyNamesName(), schema.getPropertyNames(), false, false);
+        property.setPropertyNames(propNamesProp);
+    }
+
     protected void setAddProps(Schema schema, IJsonSchemaValidationProperties property) {
         if (schema.equals(new Schema())) {
             // if we are trying to set additionalProperties on an empty schema stop recursing
@@ -3882,7 +3896,7 @@ protected void updatePropertyForObject(CodegenProperty property, Schema p) {
             // an object or anyType composed schema that has additionalProperties set
             updatePropertyForMap(property, p);
         }
-        addVarsRequiredVarsAdditionalProps(p, property);
+        addVarsRequiredVarsAdditionalPropsPropertyNames(p, property);
     }
 
     protected void updatePropertyForAnyType(CodegenProperty property, Schema p) {
@@ -3905,7 +3919,7 @@ protected void updatePropertyForAnyType(CodegenProperty property, Schema p) {
             // even though it should allow in any type and have map constraints for properties
             updatePropertyForMap(property, p);
         }
-        addVarsRequiredVarsAdditionalProps(p, property);
+        addVarsRequiredVarsAdditionalPropsPropertyNames(p, property);
     }
 
     protected void updatePropertyForString(CodegenProperty property, Schema p) {
@@ -5192,9 +5206,9 @@ public CodegenResponse fromResponse(String responseCode, ApiResponse response) {
             r.simpleType = false;
             r.containerType = cp.containerType;
             r.containerTypeMapped = cp.containerTypeMapped;
-            addVarsRequiredVarsAdditionalProps(responseSchema, r);
+            addVarsRequiredVarsAdditionalPropsPropertyNames(responseSchema, r);
         } else if (ModelUtils.isAnyType(responseSchema)) {
-            addVarsRequiredVarsAdditionalProps(responseSchema, r);
+            addVarsRequiredVarsAdditionalPropsPropertyNames(responseSchema, r);
         } else if (!ModelUtils.isBooleanSchema(responseSchema)) {
             // referenced schemas
             LOGGER.debug("Property type is not primitive: {}", cp.dataType);
@@ -5505,14 +5519,14 @@ public CodegenParameter fromParameter(Parameter parameter, Set<String> imports)
             if (ModelUtils.isFreeFormObject(parameterSchema, openAPI)) {
                 codegenParameter.isFreeFormObject = true;
             }
-            addVarsRequiredVarsAdditionalProps(parameterSchema, codegenParameter);
+            addVarsRequiredVarsAdditionalPropsPropertyNames(parameterSchema, codegenParameter);
         } else if (ModelUtils.isNullType(parameterSchema)) {
         } else if (ModelUtils.isAnyType(parameterSchema)) {
             // any schema with no type set, composed schemas often do this
             if (ModelUtils.isMapSchema(parameterSchema)) { // for map parameter
                 updateParameterForMap(codegenParameter, parameterSchema, imports);
             }
-            addVarsRequiredVarsAdditionalProps(parameterSchema, codegenParameter);
+            addVarsRequiredVarsAdditionalPropsPropertyNames(parameterSchema, codegenParameter);
         } else if (ModelUtils.isArraySchema(parameterSchema)) {
             Schema inner = ModelUtils.getSchemaItems(parameterSchema);
 
@@ -7859,7 +7873,7 @@ protected void updateRequestBodyForObject(CodegenParameter codegenParameter, Sch
             // object type schema or composed schema with properties defined
             this.addBodyModelSchema(codegenParameter, name, schema, imports, bodyParameterName, false);
         }
-        addVarsRequiredVarsAdditionalProps(schema, codegenParameter);
+        addVarsRequiredVarsAdditionalPropsPropertyNames(schema, codegenParameter);
     }
 
     protected void updateRequestBodyForArray(CodegenParameter codegenParameter, Schema schema, String name, Set<String> imports, String bodyParameterName) {
@@ -8144,7 +8158,7 @@ public CodegenParameter fromRequestBody(RequestBody body, Set<String> imports, S
             } else {
                 updateRequestBodyForPrimitiveType(codegenParameter, schema, bodyParameterName, imports);
             }
-            addVarsRequiredVarsAdditionalProps(schema, codegenParameter);
+            addVarsRequiredVarsAdditionalPropsPropertyNames(schema, codegenParameter);
         } else {
             // referenced schemas
             updateRequestBodyForPrimitiveType(codegenParameter, schema, bodyParameterName, imports);
@@ -8262,12 +8276,13 @@ protected void addRequiredVarsMap(Schema schema, IJsonSchemaValidationProperties
         }
     }
 
-    protected void addVarsRequiredVarsAdditionalProps(Schema schema, IJsonSchemaValidationProperties property) {
+    protected void addVarsRequiredVarsAdditionalPropsPropertyNames(Schema schema, IJsonSchemaValidationProperties property) {
         setAddProps(schema, property);
         Set<String> mandatory = schema.getRequired() == null ? Collections.emptySet()
                 : new TreeSet<>(schema.getRequired());
         addVars(property, property.getVars(), schema.getProperties(), mandatory);
         addRequiredVarsMap(schema, property);
+        setPropNames(schema, property);
     }
 
     protected String getItemsName(Schema containingSchema, String containingSchemaName) {
@@ -8282,6 +8297,10 @@ protected String getAdditionalPropertiesName() {
         return "additional_properties";
     }
 
+    protected String getPropertyNamesName() {
+        return "property_names";
+    }
+
     private void addJsonSchemaForBodyRequestInCaseItsNotPresent(CodegenParameter codegenParameter, RequestBody body) {
         if (codegenParameter.jsonSchema == null)
             codegenParameter.jsonSchema = Json.pretty(body);

modules/openapi-generator/src/main/java/org/openapitools/codegen/IJsonSchemaValidationProperties.java

@@ -136,6 +136,10 @@ public interface IJsonSchemaValidationProperties {
 
     void setAdditionalProperties(CodegenProperty additionalProperties);
 
+    CodegenProperty getPropertyNames();
+
+    void setPropertyNames(CodegenProperty propertyNames);
+
     List<CodegenProperty> getVars();
 
     void setVars(List<CodegenProperty> vars);

modules/openapi-generator/src/main/resources/typescript-angular/modelGenericAdditionalProperties.mustache

@@ -1,5 +1,8 @@
 {{#additionalPropertiesType}}
 
-  [key: string]: {{{additionalPropertiesType}}}{{#hasVars}} | any{{/hasVars}};
+    [key: string]: {{additionalPropertiesType}}{{#hasVars}} | any{{/hasVars}};
+    {{#nameOnlyVars}}
+        {{.}}?: {{additionalPropertiesType}};
+    {{/nameOnlyVars}}
 
 {{/additionalPropertiesType}}