io.swagger.v3.core.converter

Interface ModelConverterContext

All Known Implementing Classes:

ModelConverterContextImpl

public interface ModelConverterContext

Method Summary

Modifier and Type	Method and Description
void	defineModel(String name, io.swagger.v3.oas.models.media.Schema model) needs to be called whenever a Model is defined which can be referenced from another Model or Property
void	defineModel(String name, io.swagger.v3.oas.models.media.Schema model, AnnotatedType type, String prevName) needs to be called whenever a Schema is defined which can be referenced from another Model or Property
void	defineModel(String name, io.swagger.v3.oas.models.media.Schema model, Type type, String prevName) needs to be called whenever a Schema is defined which can be referenced from another Model or Property
Iterator<ModelConverter>	getConverters()
Map<String,io.swagger.v3.oas.models.media.Schema>	getDefinedModels()
io.swagger.v3.oas.models.media.Schema	resolve(AnnotatedType type)

Method Detail

defineModel

void defineModel(String name,
                 io.swagger.v3.oas.models.media.Schema model)

needs to be called whenever a Model is defined which can be referenced from another Model or Property

Parameters:

name - the name of the model

model - the Model

defineModel

void defineModel(String name,
                 io.swagger.v3.oas.models.media.Schema model,
                 AnnotatedType type,
                 String prevName)

needs to be called whenever a Schema is defined which can be referenced from another Model or Property

Parameters:

name - the name of the model

model - the Model

type - the AnnotatedType

prevName - the (optional) previous name

defineModel

void defineModel(String name,
                 io.swagger.v3.oas.models.media.Schema model,
                 Type type,
                 String prevName)

needs to be called whenever a Schema is defined which can be referenced from another Model or Property

Parameters:

name - the name of the model

model - the Model

type - the Type

prevName - the (optional) previous name

resolve

io.swagger.v3.oas.models.media.Schema resolve(AnnotatedType type)

Parameters:

type - The Schema

Returns:

a Model representation of the Class. Any referenced models will be defined already.

getDefinedModels

Map<String,io.swagger.v3.oas.models.media.Schema> getDefinedModels()

getConverters

Iterator<ModelConverter> getConverters()

Returns:

an Iterator of ModelConverters. This iterator is not reused