Make generation of @type attribute in JSON payload configurable

Author: atextor

core/esmf-aspect-model-document-generators/src/main/java/org/eclipse/esmf/aspectmodel/generator/json/AspectModelJsonPayloadGenerator.java

@@ -107,8 +107,7 @@ public Stream<JsonPayloadArtifact> generate() {
       return Stream.of( new PayloadGenerator( objectMapper ).apply( aspect(), config ) );
    }
 
-   private static class PayloadGenerator
-         implements ArtifactGenerator<String, JsonNode, Aspect, JsonPayloadGenerationConfig, JsonPayloadArtifact> {
+   private class PayloadGenerator implements ArtifactGenerator<String, JsonNode, Aspect, JsonPayloadGenerationConfig, JsonPayloadArtifact> {
       /**
        * Constant for the either left property.
        * For example JSON payloads the left type will be used.
@@ -226,7 +225,9 @@ private Map<String, Object> transformAbstractEntityProperty( final BasicProperty
             final ComplexType extendingComplexType = abstractEntity.getExtendingElements().get( 0 );
             final Map<String, Object> generatedProperties = transformProperties( extendingComplexType.getAllProperties(),
                   useModelExampleValue );
-            generatedProperties.put( "@type", extendingComplexType.getName() );
+            if ( config.addTypeAttributeForEntityInheritance() ) {
+               generatedProperties.put( "@type", extendingComplexType.getName() );
+            }
             return toMap( property.getName(), generatedProperties );
          }
          return ImmutableMap.of();
@@ -237,7 +238,7 @@ private Map<String, Object> transformEntityProperty( final BasicProperty propert
          if ( dataType.isPresent() ) {
             final Entity entity = dataType.get();
             final Map<String, Object> generatedProperties = transformProperties( entity.getAllProperties(), useModelExmplevalue );
-            if ( entity.getExtends().isPresent() ) {
+            if ( entity.getExtends().isPresent() && config.addTypeAttributeForEntityInheritance() ) {
                generatedProperties.put( "@type", entity.getName() );
             }
             return toMap( property.getName(), generatedProperties );
@@ -331,7 +332,9 @@ private Object generateCollectionValue( final Type dataType, final int minCount
             final AbstractEntity abstractEntity = dataType.as( AbstractEntity.class );
             final ComplexType extendingComplexType = abstractEntity.getExtendingElements().get( 0 );
             final Map<String, Object> propertyValueMap = transformProperties( extendingComplexType.getAllProperties(), minCount < 2 );
-            propertyValueMap.put( "@type", extendingComplexType.getName() );
+            if ( config.addTypeAttributeForEntityInheritance() ) {
+               propertyValueMap.put( "@type", extendingComplexType.getName() );
+            }
             return propertyValueMap;
          }
          if ( dataType.is( Entity.class ) ) {

core/esmf-aspect-model-document-generators/src/main/java/org/eclipse/esmf/aspectmodel/generator/json/JsonPayloadGenerationConfig.java

@@ -21,11 +21,15 @@
 import io.soabase.recordbuilder.core.RecordBuilder;
 
 /**
- * A {@link GenerationConfig} for JSON sample payload generation
+ * A {@link GenerationConfig} for JSON sample payload generation.
+ *
+ * @param randomStrategy the Random instance to use for random value generation
+ * @param addTypeAttributeForEntityInheritance if set to true, adds "@type" attribute in payloads for inherited entities
  */
 @RecordBuilder
 public record JsonPayloadGenerationConfig(
-      Random randomStrategy
+      Random randomStrategy,
+      boolean addTypeAttributeForEntityInheritance
 ) implements JsonGenerationConfig {
    public JsonPayloadGenerationConfig {
       if ( randomStrategy == null ) {