Package io.smallrye.openapi.runtime.io

Class OpenAPIDefinitionIO<V,A extends V,O extends V,AB,OB>

java.lang.Object

io.smallrye.openapi.runtime.io.ModelIO<org.eclipse.microprofile.openapi.models.OpenAPI,V,A,O,AB,OB>

io.smallrye.openapi.runtime.io.OpenAPIDefinitionIO<V,A,O,AB,OB>

All Implemented Interfaces:

JsonIO.PropertyMapper<V,OB>

public class OpenAPIDefinitionIO<V,A extends V,O extends V,AB,OB>
extends ModelIO<org.eclipse.microprofile.openapi.models.OpenAPI,V,A,O,AB,OB>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROP_COMPONENTS
static final String	PROP_EXTERNAL_DOCS
static final String	PROP_INFO
static final String	PROP_OPENAPI
static final String	PROP_PATHS
static final String	PROP_SECURITY
static final String	PROP_SECURITY_SETS
static final String	PROP_SERVERS
static final String	PROP_TAGS
static final String	PROP_WEBHOOKS

Fields inherited from class io.smallrye.openapi.runtime.io.ModelIO

annotationName, modelName

Constructor Summary

Constructors

Constructor	Description
OpenAPIDefinitionIO(IOContext<V,A,O,AB,OB> context)

Method Summary

Modifier and Type	Method	Description
org.eclipse.microprofile.openapi.models.OpenAPI	read(org.jboss.jandex.AnnotationInstance annotation)
org.eclipse.microprofile.openapi.models.OpenAPI	readObject(O node)	Reads a OpenAPIDefinition Json node.
Optional<O>	write(org.eclipse.microprofile.openapi.models.OpenAPI model)

Methods inherited from class io.smallrye.openapi.runtime.io.ModelIO

apiResponseIO, apiResponsesIO, callbackIO, callbackOperationIO, componentsIO, contactIO, contentIO, discriminatorIO, encodingIO, entry, enumValue, enumValue, exampleObjectIO, extDocIO, extensionIO, getAnnotation, getName, getName, getRepeatableAnnotations, hasRepeatableAnnotation, headerIO, infoIO, ioContext, jsonIO, licenseIO, linkIO, linkParameterIO, mapObject, mapObject, mapProperty, mediaTypeIO, not, oauthFlowIO, oauthFlowsIO, oauthScopeIO, openApiDefinitionIO, openApiVersion, operationIO, optionalJsonArray, optionalJsonObject, parameterIO, pathItemIO, pathItemOperationIO, pathsIO, read, read, read, readJson, readObject, readValue, readValue, requestBodyIO, scannerContext, schemaIO, securityIO, securityRequirementIO, securityRequirementsSetIO, securitySchemeIO, serverIO, serverVariableIO, setAllIfPresent, setIfPresent, setOpenApiVersion, setProperty, setProperty, tagIO, toLinkedMap, value, value

Methods inherited from class java.lang.Object

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

Field Details

PROP_COMPONENTS

public static final String PROP_COMPONENTS

See Also:

• Constant Field Values

PROP_EXTERNAL_DOCS

public static final String PROP_EXTERNAL_DOCS

See Also:

• Constant Field Values

PROP_INFO

public static final String PROP_INFO

See Also:

• Constant Field Values

PROP_OPENAPI

public static final String PROP_OPENAPI

See Also:

• Constant Field Values

PROP_PATHS

public static final String PROP_PATHS

See Also:

• Constant Field Values

PROP_SECURITY

public static final String PROP_SECURITY

See Also:

• Constant Field Values

PROP_SECURITY_SETS

public static final String PROP_SECURITY_SETS

See Also:

• Constant Field Values

PROP_SERVERS

public static final String PROP_SERVERS

See Also:

• Constant Field Values

PROP_TAGS

public static final String PROP_TAGS

See Also:

• Constant Field Values

PROP_WEBHOOKS

public static final String PROP_WEBHOOKS

See Also:

• Constant Field Values

Constructor Details

OpenAPIDefinitionIO

public OpenAPIDefinitionIO(IOContext<V,A,O,AB,OB> context)

Method Details

read

public org.eclipse.microprofile.openapi.models.OpenAPI read(org.jboss.jandex.AnnotationInstance annotation)

Specified by:

read in class ModelIO<org.eclipse.microprofile.openapi.models.OpenAPI,V,A extends V,O extends V,AB,OB>

readObject

public org.eclipse.microprofile.openapi.models.OpenAPI readObject(O node)

Reads a OpenAPIDefinition Json node.

Overrides:

readObject in class ModelIO<org.eclipse.microprofile.openapi.models.OpenAPI,V,A extends V,O extends V,AB,OB>

Parameters:

node - the Json node

write

public Optional<O> write(org.eclipse.microprofile.openapi.models.OpenAPI model)

Overrides:

write in class ModelIO<org.eclipse.microprofile.openapi.models.OpenAPI,V,A extends V,O extends V,AB,OB>