additional properties support

Author: winrid

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

@@ -291,6 +291,15 @@ public CodegenModel fromModel(String name, Schema model) {
             }
         }
 
+        // Handle additionalProperties for models that have both properties and additionalProperties
+        Schema addlProps = ModelUtils.getAdditionalProperties(model);
+        if (addlProps != null && model.getProperties() != null && !model.getProperties().isEmpty()) {
+            // This model has both defined properties AND additionalProperties
+            codegenModel.additionalPropertiesType = getTypeDeclaration(addlProps);
+            // Add import for web::json::value which is used to store additional properties
+            codegenModel.imports.add("#include <cpprest/json.h>");
+        }
+
         return codegenModel;
     }
 
@@ -386,6 +395,18 @@ private Schema resolveSchema(Schema schema) {
      * @return a string value used as the `dataType` field for model templates,
      * `returnType` for api templates
      */
+    /**
+     * Check if a schema is a pure map (has additionalProperties but no defined properties).
+     * Schemas with both properties and additionalProperties should be treated as models, not maps.
+     */
+    private boolean isPureMapSchema(Schema schema) {
+        if (!ModelUtils.isMapSchema(schema)) {
+            return false;
+        }
+        // If the schema has defined properties, it's not a pure map
+        return schema.getProperties() == null || schema.getProperties().isEmpty();
+    }
+
     @Override
     public String getTypeDeclaration(Schema p) {
         // Resolve the schema to check for nested maps/arrays - refs that point to map schemas
@@ -394,7 +415,8 @@ public String getTypeDeclaration(Schema p) {
         if (ModelUtils.isArraySchema(resolved)) {
             Schema inner = ModelUtils.getSchemaItems(resolved);
             return getSchemaType(p) + "<" + getTypeDeclaration(inner) + ">";
-        } else if (ModelUtils.isMapSchema(resolved)) {
+        } else if (isPureMapSchema(resolved)) {
+            // Only treat as map if it has additionalProperties but NO defined properties
             Schema inner = ModelUtils.getAdditionalProperties(resolved);
             return getSchemaType(p) + "<utility::string_t, " + getTypeDeclaration(inner) + ">";
         }
@@ -435,7 +457,7 @@ public String toDefaultValue(Schema p) {
                 return "0L";
             }
             return "0";
-        } else if (ModelUtils.isMapSchema(p)) {
+        } else if (isPureMapSchema(p)) {
             String inner = getSchemaType(ModelUtils.getAdditionalProperties(p));
             return "std::map<utility::string_t, " + inner + ">()";
         } else if (ModelUtils.isArraySchema(p)) {

modules/openapi-generator/src/main/resources/cpp-rest-sdk-client/model-header.mustache

@@ -261,6 +261,23 @@ public:
     {{/isInherited}}
 
     {{/vars}}
+    {{#additionalPropertiesType}}
+
+    /// <summary>
+    /// Get additional properties (properties not defined in the schema)
+    /// </summary>
+    std::map<utility::string_t, web::json::value> getAdditionalProperties() const;
+    bool additionalPropertiesIsSet() const;
+    void unsetAdditionalProperties();
+    /// <summary>
+    /// Set additional properties
+    /// </summary>
+    void setAdditionalProperties(const std::map<utility::string_t, web::json::value>& value);
+    /// <summary>
+    /// Add a single additional property
+    /// </summary>
+    void addAdditionalProperty(const utility::string_t& key, const web::json::value& value);
+    {{/additionalPropertiesType}}
 
 protected:
     {{#vars}}
@@ -285,6 +302,10 @@ protected:
     {{/isInherited}}
 
     {{/vars}}
+    {{#additionalPropertiesType}}
+    std::map<utility::string_t, web::json::value> m_AdditionalProperties;
+    bool m_AdditionalPropertiesIsSet;
+    {{/additionalPropertiesType}}
 };
 
 {{/isEnum}}

modules/openapi-generator/src/main/resources/cpp-rest-sdk-client/model-source.mustache

@@ -207,6 +207,9 @@ void {{classname}}::setValue({{classname}}::e{{classname}} const value)
     {{/isNullable}}
     {{/isInherited}}
     {{/vars}}
+    {{#additionalPropertiesType}}
+    m_AdditionalPropertiesIsSet = false;
+    {{/additionalPropertiesType}}
 }
 
 {{classname}}::~{{classname}}()
@@ -262,6 +265,16 @@ web::json::value {{classname}}::toJson() const
     {{/isNullable}}
     {{/isInherited}}
     {{/vars}}
+    {{#additionalPropertiesType}}
+    // Serialize additional properties
+    if(m_AdditionalPropertiesIsSet)
+    {
+        for(const auto& item : m_AdditionalProperties)
+        {
+            val[item.first] = item.second;
+        }
+    }
+    {{/additionalPropertiesType}}
 
     return val;
 }
@@ -295,6 +308,24 @@ bool {{classname}}::fromJson(const web::json::value& val)
     }
     {{/isInherited}}
     {{/vars}}
+    {{#additionalPropertiesType}}
+    // Capture additional properties (keys not defined in the schema)
+    if(val.is_object())
+    {
+        for(const auto& item : val.as_object())
+        {
+            // Skip known properties
+            {{#vars}}
+            {{^isInherited}}
+            if(item.first == utility::conversions::to_string_t(_XPLATSTR("{{baseName}}"))) continue;
+            {{/isInherited}}
+            {{/vars}}
+            // This is an additional property
+            m_AdditionalProperties[item.first] = item.second;
+            m_AdditionalPropertiesIsSet = true;
+        }
+    }
+    {{/additionalPropertiesType}}
     return ok;
 }
 
@@ -515,6 +546,36 @@ void {{classname}}::unset{{name}}()
     {{/isNullable}}
 }
 {{/isInherited}}{{/vars}}
+{{#additionalPropertiesType}}
+
+std::map<utility::string_t, web::json::value> {{classname}}::getAdditionalProperties() const
+{
+    return m_AdditionalProperties;
+}
+
+void {{classname}}::setAdditionalProperties(const std::map<utility::string_t, web::json::value>& value)
+{
+    m_AdditionalProperties = value;
+    m_AdditionalPropertiesIsSet = true;
+}
+
+void {{classname}}::addAdditionalProperty(const utility::string_t& key, const web::json::value& value)
+{
+    m_AdditionalProperties[key] = value;
+    m_AdditionalPropertiesIsSet = true;
+}
+
+bool {{classname}}::additionalPropertiesIsSet() const
+{
+    return m_AdditionalPropertiesIsSet;
+}
+
+void {{classname}}::unsetAdditionalProperties()
+{
+    m_AdditionalProperties.clear();
+    m_AdditionalPropertiesIsSet = false;
+}
+{{/additionalPropertiesType}}
 {{/isEnum}}
 {{/oneOf}}
 {{#modelNamespaceDeclarations}}

modules/openapi-generator/src/test/resources/3_0/cpp-restsdk/petstore.yaml

@@ -896,4 +896,14 @@ components:
         healthRecords:
           description: Nested map - category to (date to record)
           $ref: '#/components/schemas/NestedStringMap'
+    SchemaWithPropsAndAddlProps:
+      description: Object with both defined properties and additionalProperties
+      type: object
+      nullable: true
+      properties:
+        propA:
+          type: string
+        propB:
+          type: string
+      additionalProperties: {}
 

samples/client/petstore/cpp-restsdk/client/.openapi-generator/FILES

@@ -25,6 +25,7 @@ include/CppRestPetstoreClient/model/Order.h
 include/CppRestPetstoreClient/model/Page.h
 include/CppRestPetstoreClient/model/Pet.h
 include/CppRestPetstoreClient/model/PetStatistics.h
+include/CppRestPetstoreClient/model/SchemaWithPropsAndAddlProps.h
 include/CppRestPetstoreClient/model/SchemaWithSet.h
 include/CppRestPetstoreClient/model/SchemaWithSet_vaccinationBook.h
 include/CppRestPetstoreClient/model/Tag.h
@@ -51,6 +52,7 @@ src/model/Order.cpp
 src/model/Page.cpp
 src/model/Pet.cpp
 src/model/PetStatistics.cpp
+src/model/SchemaWithPropsAndAddlProps.cpp
 src/model/SchemaWithSet.cpp
 src/model/SchemaWithSet_vaccinationBook.cpp
 src/model/Tag.cpp

samples/client/petstore/cpp-restsdk/client/include/CppRestPetstoreClient/model/SchemaWithPropsAndAddlProps.h

@@ -0,0 +1,106 @@
+/**
+ * OpenAPI Petstore
+ * This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ * NOTE: This class is auto generated by OpenAPI-Generator 7.19.0-SNAPSHOT.
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/*
+ * SchemaWithPropsAndAddlProps.h
+ *
+ * Object with both defined properties and additionalProperties
+ */
+
+#ifndef ORG_OPENAPITOOLS_CLIENT_MODEL_SchemaWithPropsAndAddlProps_H_
+#define ORG_OPENAPITOOLS_CLIENT_MODEL_SchemaWithPropsAndAddlProps_H_
+
+#include <boost/optional.hpp>
+
+#include "CppRestPetstoreClient/ModelBase.h"
+
+#include <cpprest/details/basic_types.h>
+#include <map>
+#include <cpprest/json.h>
+#include "CppRestPetstoreClient/AnyType.h"
+
+namespace org {
+namespace openapitools {
+namespace client {
+namespace model {
+
+
+
+/// <summary>
+/// Object with both defined properties and additionalProperties
+/// </summary>
+class  SchemaWithPropsAndAddlProps
+    : public ModelBase
+{
+public:
+    SchemaWithPropsAndAddlProps();
+    virtual ~SchemaWithPropsAndAddlProps();
+
+    /////////////////////////////////////////////
+    /// ModelBase overrides
+
+    void validate() override;
+
+    web::json::value toJson() const override;
+    bool fromJson(const web::json::value& json) override;
+
+    void toMultipart(std::shared_ptr<MultipartFormData> multipart, const utility::string_t& namePrefix) const override;
+    bool fromMultiPart(std::shared_ptr<MultipartFormData> multipart, const utility::string_t& namePrefix) override;
+
+
+    /////////////////////////////////////////////
+    /// SchemaWithPropsAndAddlProps members
+
+
+    utility::string_t getPropA() const;
+    bool propAIsSet() const;
+    void unsetPropA();
+    void setPropA(const utility::string_t& value);
+
+    utility::string_t getPropB() const;
+    bool propBIsSet() const;
+    void unsetPropB();
+    void setPropB(const utility::string_t& value);
+
+
+    /// <summary>
+    /// Get additional properties (properties not defined in the schema)
+    /// </summary>
+    std::map<utility::string_t, web::json::value> getAdditionalProperties() const;
+    bool additionalPropertiesIsSet() const;
+    void unsetAdditionalProperties();
+    /// <summary>
+    /// Set additional properties
+    /// </summary>
+    void setAdditionalProperties(const std::map<utility::string_t, web::json::value>& value);
+    /// <summary>
+    /// Add a single additional property
+    /// </summary>
+    void addAdditionalProperty(const utility::string_t& key, const web::json::value& value);
+
+protected:
+    utility::string_t m_PropA;
+    bool m_PropAIsSet;
+
+    utility::string_t m_PropB;
+    bool m_PropBIsSet;
+
+    std::map<utility::string_t, web::json::value> m_AdditionalProperties;
+    bool m_AdditionalPropertiesIsSet;
+};
+
+
+}
+}
+}
+}
+
+#endif /* ORG_OPENAPITOOLS_CLIENT_MODEL_SchemaWithPropsAndAddlProps_H_ */