Class PolymorphicModelConverter

java.lang.Object
org.springdoc.core.converters.PolymorphicModelConverter
All Implemented Interfaces:
io.swagger.v3.core.converter.ModelConverter

public class PolymorphicModelConverter extends Object implements io.swagger.v3.core.converter.ModelConverter
The type Polymorphic model converter.
Author:
bnasslahsen
  • Field Details

    • DEFAULT_ONE_OF_REF_SUFFIX

      public static final String DEFAULT_ONE_OF_REF_SUFFIX
      The default suffix used when emitting oneOf unions as component refs.
      See Also:
  • Constructor Details

    • PolymorphicModelConverter

      public PolymorphicModelConverter(ObjectMapperProvider springDocObjectMapper)
      Instantiates a new Polymorphic model converter.
      Parameters:
      springDocObjectMapper - the spring doc object mapper
    • PolymorphicModelConverter

      public PolymorphicModelConverter(ObjectMapperProvider springDocObjectMapper, boolean oneOfAsRef)
      Instantiates a new Polymorphic model converter.
      Parameters:
      springDocObjectMapper - the spring doc object mapper
      oneOfAsRef - whether oneOf unions should be emitted as component refs
    • PolymorphicModelConverter

      public PolymorphicModelConverter(ObjectMapperProvider springDocObjectMapper, boolean oneOfAsRef, String oneOfRefSuffix)
      Instantiates a new Polymorphic model converter.
      Parameters:
      springDocObjectMapper - the spring doc object mapper
      oneOfAsRef - whether oneOf unions should be emitted as component refs
      oneOfRefSuffix - the suffix for generated oneOf component names
  • Method Details

    • addParentType

      public static void addParentType(String... parentTypes)
      Add parent type.
      Parameters:
      parentTypes - the parent types
    • resolve

      public io.swagger.v3.oas.models.media.Schema resolve(io.swagger.v3.core.converter.AnnotatedType type, io.swagger.v3.core.converter.ModelConverterContext context, Iterator<io.swagger.v3.core.converter.ModelConverter> chain)
      Specified by:
      resolve in interface io.swagger.v3.core.converter.ModelConverter