feat(openapi-generator): Add optional logic to suppress faulty additionalProperties: true (#689)

Co-authored-by: Alexander Dümont <[email protected]>

Author: newtork

datamodel/openapi/openapi-api-sample/src/main/resources/sodastore.yaml

@@ -60,6 +60,7 @@ components:
               example: 123
     Order:
       type: object
+      additionalProperties: true
       required:
         - productId
         - quantity

datamodel/openapi/openapi-api-sample/src/test/java/com/sap/cloud/sdk/datamodel/openapi/sample/api/SerializationTest.java

@@ -11,6 +11,7 @@
 import com.github.tomakehurst.wiremock.junit5.WireMockRuntimeInfo;
 import com.github.tomakehurst.wiremock.junit5.WireMockTest;
 import com.sap.cloud.sdk.cloudplatform.connectivity.DefaultHttpDestination;
+import com.sap.cloud.sdk.datamodel.openapi.sample.model.Order;
 import com.sap.cloud.sdk.datamodel.openapi.sample.model.SodaWithId;
 
 @WireMockTest
@@ -48,7 +49,7 @@ void testPutPayload()
     }
 
     @Test
-    void testJacksonSerialization()
+    void testJacksonSerializeSodaWithId()
         throws JsonProcessingException
     {
         expected = """
@@ -75,6 +76,26 @@ void testJacksonSerialization()
         assertThat(new ObjectMapper().writeValueAsString(obj)).isEqualToIgnoringWhitespace(expected);
     }
 
+    @Test
+    void testJacksonSerializeOrder()
+        throws JsonProcessingException
+    {
+        expected = """
+            {
+              "productId": 100,
+              "quantity": 5,
+              "totalPrice": 6.0,
+              "typelessProperty":null,
+              "nullableProperty":null,
+              "shoesize": 44
+            }
+            """;
+        final Order order = Order.create().productId(100L).quantity(5).totalPrice(6.0f);
+        order.setCustomField("shoesize", 44);
+        assertThat(new ObjectMapper().writeValueAsString(order)).isEqualToIgnoringWhitespace(expected);
+        assertThat(new ObjectMapper().readValue(expected, Order.class)).isEqualTo(order);
+    }
+
     private void verify( String requestBody )
     {
         WireMock

datamodel/openapi/openapi-generator/src/main/java/com/sap/cloud/sdk/datamodel/openapi/generator/GenerationConfigurationConverter.java

@@ -11,6 +11,7 @@
 
 import org.openapitools.codegen.ClientOptInput;
 import org.openapitools.codegen.CodegenConstants;
+import org.openapitools.codegen.CodegenModel;
 import org.openapitools.codegen.CodegenOperation;
 import org.openapitools.codegen.config.GlobalSettings;
 import org.openapitools.codegen.languages.JavaClientCodegen;
@@ -23,6 +24,7 @@
 
 import io.swagger.parser.OpenAPIParser;
 import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.media.Schema;
 import io.swagger.v3.parser.core.models.AuthorizationValue;
 import io.swagger.v3.parser.core.models.ParseOptions;
 import lombok.extern.slf4j.Slf4j;
@@ -89,6 +91,16 @@ public OperationsMap postProcessOperationsWithModels(
                 }
                 return super.postProcessOperationsWithModels(ops, allModels);
             }
+
+            @SuppressWarnings( { "rawtypes", "RedundantSuppression" } )
+            @Override
+            protected void updateModelForObject( @Nonnull final CodegenModel m, @Nonnull final Schema schema )
+            {
+                // Disable additional attributes to prevent model classes from extending "HashMap"
+                // SAP Cloud SDK offers custom field APIs to handle additional attributes already
+                schema.setAdditionalProperties(Boolean.FALSE);
+                super.updateModelForObject(m, schema);
+            }
         };
     }
 

release_notes.md

@@ -21,4 +21,5 @@
 
 ### 🐛 Fixed Issues
 
-- 
+- Fix non-compilable code using OpenAPI generator with schema definitions having `additionalProperties: true`.
+  Previously they would result in model classes extending `HashMap`, which disabled proper deserialization and serialization.