Package ubic.gemma.rest.swagger.resolver

Class CustomModelResolver

java.lang.Object

io.swagger.v3.core.jackson.AbstractModelConverter

io.swagger.v3.core.jackson.ModelResolver

ubic.gemma.rest.swagger.resolver.CustomModelResolver

All Implemented Interfaces:

io.swagger.v3.core.converter.ModelConverter

@Component
public class CustomModelResolver
extends io.swagger.v3.core.jackson.ModelResolver

Resolve Arg parameters' schema.

This should always be added last with ModelConverters.addConverter(ModelConverter) to take priority as it addresses a glitch in the original ModelResolver.

Author:

poirigui

Field Summary

Fields inherited from class io.swagger.v3.core.jackson.ModelResolver

composedModelPropertiesAsSibling, enumsAsRef, NOT_NULL_ANNOTATIONS, SET_PROPERTY_OF_COMPOSED_MODEL_AS_SIBLING, SET_PROPERTY_OF_ENUMS_AS_REF

Fields inherited from class io.swagger.v3.core.jackson.AbstractModelConverter

_intr, _mapper, _resolvedTypeNames, _typeNameResolver

Constructor Summary

Constructors

Constructor	Description
CustomModelResolver(com.fasterxml.jackson.databind.ObjectMapper objectMapper, SearchService searchService)

Method Summary

Modifier and Type	Method	Description
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)
protected List<String>	resolveAllowableValues(com.fasterxml.jackson.databind.introspect.Annotated a, Annotation[] annotations, io.swagger.v3.oas.annotations.media.Schema schema)	Resolves allowed values for the SearchWebService.search(QueryArg, TaxonArg, PlatformArg, List, LimitArg, ExcludeArg) resultTypes argument.
protected String	resolveDescription(com.fasterxml.jackson.databind.introspect.Annotated a, Annotation[] annotations, io.swagger.v3.oas.annotations.media.Schema schema)
protected Map<String,Object>	resolveExtensions(com.fasterxml.jackson.databind.introspect.Annotated a, Annotation[] annotations, io.swagger.v3.oas.annotations.media.Schema schema)

Methods inherited from class io.swagger.v3.core.jackson.ModelResolver

_addEnumProps, _isOptionalType, addRequiredItem, applyBeanValidatorAnnotations, applyBeanValidatorAnnotations, buildRefSchemaIfObject, decorateModelName, findJsonValueType, getComposedSchemaReferencedClasses, hasHiddenAnnotation, hiddenByJsonView, ignore, ignore, isObjectSchema, isOpenapi31, objectMapper, openapi31, resolve$anchor, resolve$comment, resolve$dynamicAnchor, resolve$schema, resolve$vocabulary, resolveAccessMode, resolveConst, resolveContains, resolveContentEncoding, resolveContentMediaType, resolveDefaultValue, resolveDependentRequired, resolveDependentSchemas, resolveDependentSchemas, resolveDeprecated, resolveDiscriminator, resolveDiscriminatorProperty, resolveExample, resolveExclusiveMaximum, resolveExclusiveMaximumValue, resolveExclusiveMinimum, resolveExclusiveMinimumValue, resolveExtensions, resolveExternalDocumentation, resolveExternalDocumentation, resolveFormat, resolveId, resolveIgnoredProperties, resolveIgnoredProperties, resolveMaxContains, resolveMaximum, resolveMaxItems, resolveMaxLength, resolveMaxProperties, resolveMinContains, resolveMinimum, resolveMinItems, resolveMinLength, resolveMinProperties, resolveMultipleOf, resolveNullable, resolvePattern, resolvePatternProperties, resolvePatternProperties, resolveProperties, resolveReadOnly, resolveRequiredMode, resolveRequiredProperties, resolveSchemaMembers, resolveSchemaMembers, resolveSchemaMembers, resolveSchemaProperties, resolveTitle, resolveUnevaluatedItems, resolveUniqueItems, resolveWrapping, resolveWriteOnly, resolveXml, setOpenapi31, shouldIgnoreClass

Methods inherited from class io.swagger.v3.core.jackson.AbstractModelConverter

_findTypeName, _isSetType, _subTypeName, _typeName, _typeName, _typeQName

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomModelResolver

@Autowired
public CustomModelResolver(@Qualifier("swaggerObjectMapper")
                           com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                           SearchService searchService)

Method Detail

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

Overrides:

resolve in class io.swagger.v3.core.jackson.ModelResolver

resolveAllowableValues

protected List<String> resolveAllowableValues(com.fasterxml.jackson.databind.introspect.Annotated a,
                                              Annotation[] annotations,
                                              io.swagger.v3.oas.annotations.media.Schema schema)

Resolves allowed values for the SearchWebService.search(QueryArg, TaxonArg, PlatformArg, List, LimitArg, ExcludeArg) resultTypes argument.

This ensures that the OpenAPI specification exposes all supported search result types in the SearchService as allowable values.

Overrides:

resolveAllowableValues in class io.swagger.v3.core.jackson.ModelResolver

resolveDescription

protected String resolveDescription(com.fasterxml.jackson.databind.introspect.Annotated a,
                                    Annotation[] annotations,
                                    io.swagger.v3.oas.annotations.media.Schema schema)

Overrides:

resolveDescription in class io.swagger.v3.core.jackson.ModelResolver

resolveExtensions

protected Map<String,Object> resolveExtensions(com.fasterxml.jackson.databind.introspect.Annotated a,
                                                     Annotation[] annotations,
                                                     io.swagger.v3.oas.annotations.media.Schema schema)

Overrides:

resolveExtensions in class io.swagger.v3.core.jackson.ModelResolver