org.sdase.commons.server.openapi.hal

Class HALModelResolver

java.lang.Object

io.swagger.v3.core.jackson.AbstractModelConverter

io.swagger.v3.core.jackson.ModelResolver

org.sdase.commons.server.openapi.hal.HALModelResolver

All Implemented Interfaces:

io.swagger.v3.core.converter.ModelConverter

public class HALModelResolver
extends io.swagger.v3.core.jackson.ModelResolver

Converter to handle HAL annotated classes.

It ensures embedded resources and links are arranged into an "_embedded" and "_links" object respectively.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HALModelResolver.HalModifiedAnnotation A custom annotation tto show that a type was already handled by the discovery logic.
static class	HALModelResolver.HALReservedProperty Enumeration of properties reserved for HAL along with the association to the annotation marking objects to go into these properties.

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 and Description
HALModelResolver(com.fasterxml.jackson.databind.ObjectMapper mapper)

Method Summary

Modifier and Type	Method and Description
io.swagger.v3.oas.models.media.Schema	resolve(io.swagger.v3.core.converter.AnnotatedType type, io.swagger.v3.core.converter.ModelConverterContext context, java.util.Iterator<io.swagger.v3.core.converter.ModelConverter> chain)

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

_addEnumProps, _isOptionalType, addRequiredItem, applyBeanValidatorAnnotations, decorateModelName, findJsonValueType, getComposedSchemaReferencedClasses, hasHiddenAnnotation, hiddenByJsonView, ignore, ignore, objectMapper, resolveAccessMode, resolveAllowableValues, resolveDefaultValue, resolveDeprecated, resolveDescription, resolveDiscriminator, resolveDiscriminatorProperty, resolveExample, resolveExclusiveMaximum, resolveExclusiveMinimum, resolveExtensions, resolveExtensions, resolveExternalDocumentation, resolveExternalDocumentation, resolveFormat, resolveIgnoredProperties, resolveIgnoredProperties, resolveMaximum, resolveMaxItems, resolveMaxLength, resolveMaxProperties, resolveMinimum, resolveMinItems, resolveMinLength, resolveMinProperties, resolveMultipleOf, resolveNullable, resolvePattern, resolveReadOnly, resolveRequiredProperties, resolveSchemaMembers, resolveSchemaMembers, resolveTitle, resolveUniqueItems, resolveWriteOnly, resolveXml, 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

HALModelResolver

public HALModelResolver(com.fasterxml.jackson.databind.ObjectMapper mapper)

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,
                                                     java.util.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