Allow customizing / disabling PolymorphicModelConverter. Fixes #1334

Author: bnasslahsen

springdoc-openapi-common/src/main/java/org/springdoc/core/Constants.java

@@ -90,6 +90,11 @@ public final class Constants {
 	 */
 	public static final String SPRINGDOC_PAGEABLE_CONVERTER_ENABLED = "springdoc.model-converters.pageable-converter.enabled";
 
+	/**
+	 * The constant SPRINGDOC_POLYMORPHIC_CONVERTER_ENABLED.
+	 */
+	public static final String SPRINGDOC_POLYMORPHIC_CONVERTER_ENABLED = "springdoc.model-converters.polymorphic-converter.enabled";
+
 	/**
 	 * The constant SPRINGDOC_SCHEMA_RESOLVE_PROPERTIES.
 	 */

springdoc-openapi-common/src/main/java/org/springdoc/core/SpringDocConfigProperties.java

@@ -674,6 +674,12 @@ public static class ModelConverters {
 		 */
 		private PageableConverter pageableConverter = new PageableConverter();
 
+		/**
+		 * The Polymorphic model converter.
+		 */
+		private PolymorphicConverter polymorphicConverter = new PolymorphicConverter();
+
+
 		/**
 		 * Gets deprecating converter.
 		 *
@@ -710,6 +716,24 @@ public void setPageableConverter(PageableConverter pageableConverter) {
 			this.pageableConverter = pageableConverter;
 		}
 
+		/**
+		 * Gets polymorphic model converter.
+		 *
+		 * @return the polymorphic model converter
+		 */
+		public PolymorphicConverter getPolymorphicConverter() {
+			return polymorphicConverter;
+		}
+
+		/**
+		 * Sets polymorphic model converter.
+		 *
+		 * @param polymorphicConverter the polymorphic model converter
+		 */
+		public void setPolymorphicConverter(PolymorphicConverter polymorphicConverter) {
+			this.polymorphicConverter = polymorphicConverter;
+		}
+
 		/**
 		 * The type Deprecating converter.
 		 * @author bnasslashen
@@ -740,6 +764,36 @@ public void setEnabled(boolean enabled) {
 			}
 		}
 
+		/**
+		 * The type Polymorphic model converter.
+		 */
+		public static class PolymorphicConverter {
+
+			/**
+			 * The Enabled.
+			 */
+			private boolean enabled;
+
+			/**
+			 * Is enabled boolean.
+			 *
+			 * @return the boolean
+			 */
+			public boolean isEnabled() {
+				return enabled;
+			}
+
+			/**
+			 * Sets enabled.
+			 *
+			 * @param enabled the enabled
+			 */
+			public void setEnabled(boolean enabled) {
+				this.enabled = enabled;
+			}
+		}
+
+
 		/**
 		 * The type Pageable converter.
 		 * @author bnasslashen

springdoc-openapi-common/src/main/java/org/springdoc/core/SpringDocConfiguration.java

@@ -80,6 +80,7 @@
 import static org.springdoc.core.Constants.SPRINGDOC_DEPRECATING_CONVERTER_ENABLED;
 import static org.springdoc.core.Constants.SPRINGDOC_ENABLED;
 import static org.springdoc.core.Constants.SPRINGDOC_PAGEABLE_CONVERTER_ENABLED;
+import static org.springdoc.core.Constants.SPRINGDOC_POLYMORPHIC_CONVERTER_ENABLED;
 import static org.springdoc.core.Constants.SPRINGDOC_SCHEMA_RESOLVE_PROPERTIES;
 import static org.springdoc.core.Constants.SPRINGDOC_SHOW_ACTUATOR;
 import static org.springdoc.core.SpringDocUtils.getConfig;
@@ -193,6 +194,7 @@ PageableOpenAPIConverter pageableOpenAPIConverter() {
 	 */
 	@Bean
 	@ConditionalOnMissingBean
+	@ConditionalOnProperty(name = SPRINGDOC_POLYMORPHIC_CONVERTER_ENABLED, matchIfMissing = true)
 	@Lazy(false)
 	PolymorphicModelConverter polymorphicModelConverter() {
 		return new PolymorphicModelConverter();

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app168/AbstractParent.java

@@ -0,0 +1,47 @@
+package test.org.springdoc.api.app168;
+
+import com.fasterxml.jackson.annotation.JsonSubTypes;
+import com.fasterxml.jackson.annotation.JsonSubTypes.Type;
+import com.fasterxml.jackson.annotation.JsonTypeInfo;
+import com.fasterxml.jackson.annotation.JsonTypeInfo.Id;
+
+@JsonTypeInfo(use = Id.NAME, property = "type")
+@JsonSubTypes({
+		@Type(ChildOfAbstract1.class),
+		@Type(ChildOfAbstract2.class)
+})
+public abstract class AbstractParent {
+	private int id;
+
+	public int getId() {
+		return id;
+	}
+
+	public void setId(int id) {
+		this.id = id;
+	}
+}
+
+class ChildOfAbstract1 extends AbstractParent {
+	private String abstrachChild1Param;
+
+	public String getAbstrachChild1Param() {
+		return abstrachChild1Param;
+	}
+
+	public void setAbstrachChild1Param(String abstrachChild1Param) {
+		this.abstrachChild1Param = abstrachChild1Param;
+	}
+}
+
+class ChildOfAbstract2 extends AbstractParent {
+	private String abstractChild2Param;
+
+	public String getAbstractChild2Param() {
+		return abstractChild2Param;
+	}
+
+	public void setAbstractChild2Param(String abstractChild2Param) {
+		this.abstractChild2Param = abstractChild2Param;
+	}
+}

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app168/ConcreteParent.java

@@ -0,0 +1,47 @@
+package test.org.springdoc.api.app168;
+
+import com.fasterxml.jackson.annotation.JsonSubTypes;
+import com.fasterxml.jackson.annotation.JsonSubTypes.Type;
+import com.fasterxml.jackson.annotation.JsonTypeInfo;
+import com.fasterxml.jackson.annotation.JsonTypeInfo.Id;
+
+@JsonTypeInfo(use = Id.NAME, property = "type")
+@JsonSubTypes({
+		@Type(ChildOfConcrete1.class),
+		@Type(ChildOfConcrete2.class)
+})
+public class ConcreteParent {
+	private int id;
+
+	public int getId() {
+		return id;
+	}
+
+	public void setId(int id) {
+		this.id = id;
+	}
+}
+
+class ChildOfConcrete1 extends ConcreteParent {
+	private String concreteChild1Param;
+
+	public String getConcreteChild1Param() {
+		return concreteChild1Param;
+	}
+
+	public void setConcreteChild1Param(String concreteChild1Param) {
+		this.concreteChild1Param = concreteChild1Param;
+	}
+}
+
+class ChildOfConcrete2 extends ConcreteParent {
+	private String concreteChild2Param;
+
+	public String getConcreteChild2Param() {
+		return concreteChild2Param;
+	}
+
+	public void setConcreteChild2Param(String concreteChild2Param) {
+		this.concreteChild2Param = concreteChild2Param;
+	}
+}

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app168/Controller.java

@@ -0,0 +1,44 @@
+package test.org.springdoc.api.app168;
+
+import java.util.List;
+
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+@RequestMapping("class-hierarchy")
+public class Controller {
+	@PostMapping("abstract-parent")
+	public Response abstractParent(@RequestBody AbstractParent payload) {
+		return null;
+	}
+
+	@PostMapping("concrete-parent")
+	public Response concreteParent(@RequestBody ConcreteParent payload) {
+		return null;
+	}
+}
+
+class Response {
+	AbstractParent abstractParent;
+
+	List<ConcreteParent> concreteParents;
+
+	public AbstractParent getAbstractParent() {
+		return abstractParent;
+	}
+
+	public void setAbstractParent(AbstractParent abstractParent) {
+		this.abstractParent = abstractParent;
+	}
+
+	public List<ConcreteParent> getConcreteParents() {
+		return concreteParents;
+	}
+
+	public void setConcreteParents(List<ConcreteParent> concreteParents) {
+		this.concreteParents = concreteParents;
+	}
+}

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app168/SpringDocApp168Test.java

@@ -0,0 +1,28 @@
+package test.org.springdoc.api.app168;
+
+import java.util.Optional;
+
+import io.swagger.v3.core.converter.ModelConverter;
+import io.swagger.v3.core.converter.ModelConverters;
+import org.springdoc.core.Constants;
+import org.springdoc.core.converters.PolymorphicModelConverter;
+import test.org.springdoc.api.AbstractSpringDocTest;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.test.context.TestPropertySource;
+
+
+@TestPropertySource(properties = Constants.SPRINGDOC_POLYMORPHIC_CONVERTER_ENABLED + "=false")
+public class SpringDocApp168Test extends AbstractSpringDocTest {
+
+	@SpringBootApplication
+	static class SpringDocTestApp {}
+
+	static {
+		Optional<ModelConverter> modelConverterOptional =
+				ModelConverters.getInstance().getConverters()
+						.stream().filter(modelConverter -> modelConverter instanceof PolymorphicModelConverter).findAny();
+		modelConverterOptional.ifPresent(ModelConverters.getInstance()::removeConverter);
+	}
+
+}