io.smallrye.openapi.runtime.scanner

Class SchemaRegistry

java.lang.Object

io.smallrye.openapi.runtime.scanner.SchemaRegistry

public class SchemaRegistry
extends Object

A simple registry used to track schemas that have been generated and inserted into the #/components section of the

Author:

[email protected]

Method Summary

Modifier and Type	Method and Description
static org.eclipse.microprofile.openapi.models.media.Schema	checkRegistration(org.jboss.jandex.Type type, TypeResolver resolver, org.eclipse.microprofile.openapi.models.media.Schema schema) Check if the entityType is eligible for registration using the typeResolver.
static SchemaRegistry	currentInstance() Retrieve the SchemaRegistry previously created by newInstance for the current thread, or null if none has yet been created.
boolean	has(org.jboss.jandex.Type instanceType)
org.eclipse.microprofile.openapi.models.media.Schema	lookupRef(org.jboss.jandex.Type instanceType)
static SchemaRegistry	newInstance(OpenApiConfig config, org.eclipse.microprofile.openapi.models.OpenAPI oai, org.jboss.jandex.IndexView index) Create a new instance of a SchemaRegistry on this thread.
org.eclipse.microprofile.openapi.models.media.Schema	register(org.jboss.jandex.Type entityType, org.eclipse.microprofile.openapi.models.media.Schema schema) Register the provided Schema for the provided Type.
static void	remove()
boolean	schemaReferenceSupported()

Methods inherited from class java.lang.Object

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

Method Detail

newInstance

public static SchemaRegistry newInstance(OpenApiConfig config,
                                         org.eclipse.microprofile.openapi.models.OpenAPI oai,
                                         org.jboss.jandex.IndexView index)

Create a new instance of a SchemaRegistry on this thread. The registry returned by this method may also be obtained by subsequent calls to currentInstance(). Additional calls of this method will replace the registry in the current thread context with a new instance.

Parameters:

config - current runtime configuration

oai - the OpenAPI being constructed by the scan

index - indexed class information

Returns:

the registry

currentInstance

public static SchemaRegistry currentInstance()

Retrieve the SchemaRegistry previously created by newInstance for the current thread, or null if none has yet been created.

Returns:

a SchemaRegistry instance or null

remove

public static void remove()

checkRegistration

public static org.eclipse.microprofile.openapi.models.media.Schema checkRegistration(org.jboss.jandex.Type type,
                                                                                     TypeResolver resolver,
                                                                                     org.eclipse.microprofile.openapi.models.media.Schema schema)

Check if the entityType is eligible for registration using the typeResolver. The eligible kinds of types are

• CLASS
• PARAMETERIZED_TYPE
• TYPE_VARIABLE
• WILDCARD_TYPE

If eligible, schema references are enabled by MP Config property mp.openapi.extensions.schema-references.enable, and the resolved type is available in the registry's IndexView then the schema can be registered. Only if the type has not already been registered earlier will it be added.

Parameters:

type - the Type the Schema applies to

resolver - a TypeResolver that will be used to resolve parameterized and wildcard types

schema - Schema to add to the registry

Returns:

the same schema if not eligible for registration, or a reference to the schema registered for the given Type

register

public org.eclipse.microprofile.openapi.models.media.Schema register(org.jboss.jandex.Type entityType,
                                                                     org.eclipse.microprofile.openapi.models.media.Schema schema)

Register the provided Schema for the provided Type. If an existing schema has already been registered for the type, it will be replaced by the schema given in this method.

Parameters:

entityType - the type the Schema applies to

schema - Schema to add to the registry

Returns:

a reference to the newly registered Schema

lookupRef

public org.eclipse.microprofile.openapi.models.media.Schema lookupRef(org.jboss.jandex.Type instanceType)

has

public boolean has(org.jboss.jandex.Type instanceType)

schemaReferenceSupported

public boolean schemaReferenceSupported()