org.springdoc.core.converters

Class SchemaPropertyDeprecatingConverter

java.lang.Object

org.springdoc.core.converters.SchemaPropertyDeprecatingConverter

All Implemented Interfaces:

io.swagger.v3.core.converter.ModelConverter

public class SchemaPropertyDeprecatingConverter
extends Object
implements io.swagger.v3.core.converter.ModelConverter

The type Schema property deprecating converter.

Author:

bnasslahsen

Constructor Summary

Constructors

Constructor and Description
SchemaPropertyDeprecatingConverter()

Method Summary

Modifier and Type	Method and Description
static void	addDeprecatedType(Class<? extends Annotation> cls) Add deprecated type.
static boolean	containsDeprecatedAnnotation(Annotation[] annotations) Contains deprecated annotation boolean.
static boolean	isDeprecated(Method method) Is deprecated boolean.
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)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.swagger.v3.core.converter.ModelConverter

isOpenapi31

Constructor Detail

SchemaPropertyDeprecatingConverter

public SchemaPropertyDeprecatingConverter()

Method Detail

containsDeprecatedAnnotation

public static boolean containsDeprecatedAnnotation(Annotation[] annotations)

Contains deprecated annotation boolean.

Parameters:

annotations - the annotations

Returns:

the boolean

addDeprecatedType

public static void addDeprecatedType(Class<? extends Annotation> cls)

Add deprecated type.

Parameters:

cls - the cls

isDeprecated

public static boolean isDeprecated(Method method)

Is deprecated boolean.

Parameters:

method - the annotated element

Returns:

the boolean

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