Package io.smallrye.openapi.runtime.io

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

java.lang.Object

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

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

Direct Known Subclasses:

CallbackOperationIO

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

Field Summary

Fields

Modifier and Type	Field	Description
protected final ExtensionIO<V,A,O,AB,OB>	extensionIO
protected final ExternalDocumentationIO<V,A,O,AB,OB>	externalDocIO
protected static final String	PROP_CALLBACKS
protected static final String	PROP_DEPRECATED
protected static final String	PROP_DESCRIPTION
protected static final String	PROP_EXTERNAL_DOCS
protected static final String	PROP_HIDDEN
protected static final String	PROP_OPERATION_ID
protected static final String	PROP_PARAMETERS
protected static final String	PROP_REQUEST_BODY
protected static final String	PROP_RESPONSES
protected static final String	PROP_SECURITY
protected static final String	PROP_SECURITY_SETS
protected static final String	PROP_SERVERS
protected static final String	PROP_SUMMARY
protected static final String	PROP_TAGS
protected final APIResponsesIO<V,A,O,AB,OB>	responsesIO

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

annotationName, modelName

Constructor Summary

Constructors

Constructor	Description
OperationIO(IOContext<V,A,O,AB,OB> context, ContentIO<V,A,O,AB,OB> contentIO, CallbackIO<V,A,O,AB,OB> callbackIO, ExtensionIO<V,A,O,AB,OB> extensionIO)
OperationIO(IOContext<V,A,O,AB,OB> context, ContentIO<V,A,O,AB,OB> contentIO, ExtensionIO<V,A,O,AB,OB> extensionIO)
OperationIO(IOContext<V,A,O,AB,OB> context, org.jboss.jandex.DotName annotationName, ContentIO<V,A,O,AB,OB> contentIO, CallbackIO<V,A,O,AB,OB> callbackIO, ExtensionIO<V,A,O,AB,OB> extensionIO)

Method Summary

Modifier and Type	Method	Description
boolean	isHidden(org.jboss.jandex.AnnotationTarget target)
org.eclipse.microprofile.openapi.models.Operation	read(org.jboss.jandex.AnnotationInstance annotationInstance)
org.eclipse.microprofile.openapi.models.Operation	readObject(O node)
Optional<O>	write(org.eclipse.microprofile.openapi.models.Operation model)

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

entry, enumValue, enumValue, getAnnotation, getName, getName, getRepeatableAnnotations, hasRepeatableAnnotation, ioContext, jsonIO, not, optionalJsonArray, optionalJsonObject, read, read, readValue, scannerContext, setAllIfPresent, setIfPresent, toLinkedMap, value, value

Methods inherited from class java.lang.Object

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

Field Details

PROP_OPERATION_ID

protected static final String PROP_OPERATION_ID

See Also:

• Constant Field Values

PROP_TAGS

protected static final String PROP_TAGS

See Also:

• Constant Field Values

PROP_DESCRIPTION

protected static final String PROP_DESCRIPTION

See Also:

• Constant Field Values

PROP_SECURITY

protected static final String PROP_SECURITY

See Also:

• Constant Field Values

PROP_SECURITY_SETS

protected static final String PROP_SECURITY_SETS

See Also:

• Constant Field Values

PROP_REQUEST_BODY

protected static final String PROP_REQUEST_BODY

See Also:

• Constant Field Values

PROP_PARAMETERS

protected static final String PROP_PARAMETERS

See Also:

• Constant Field Values

PROP_SERVERS

protected static final String PROP_SERVERS

See Also:

• Constant Field Values

PROP_SUMMARY

protected static final String PROP_SUMMARY

See Also:

• Constant Field Values

PROP_DEPRECATED

protected static final String PROP_DEPRECATED

See Also:

• Constant Field Values

PROP_CALLBACKS

protected static final String PROP_CALLBACKS

See Also:

• Constant Field Values

PROP_HIDDEN

protected static final String PROP_HIDDEN

See Also:

• Constant Field Values

PROP_RESPONSES

protected static final String PROP_RESPONSES

See Also:

• Constant Field Values

PROP_EXTERNAL_DOCS

protected static final String PROP_EXTERNAL_DOCS

See Also:

• Constant Field Values

responsesIO

protected final APIResponsesIO<V,A extends V,O extends V,AB,OB> responsesIO

externalDocIO

protected final ExternalDocumentationIO<V,A extends V,O extends V,AB,OB> externalDocIO

extensionIO

protected final ExtensionIO<V,A extends V,O extends V,AB,OB> extensionIO

Constructor Details

OperationIO

public OperationIO(IOContext<V,A,O,AB,OB> context,
 ContentIO<V,A,O,AB,OB> contentIO,
 CallbackIO<V,A,O,AB,OB> callbackIO,
 ExtensionIO<V,A,O,AB,OB> extensionIO)

OperationIO

public OperationIO(IOContext<V,A,O,AB,OB> context,
 org.jboss.jandex.DotName annotationName,
 ContentIO<V,A,O,AB,OB> contentIO,
 CallbackIO<V,A,O,AB,OB> callbackIO,
 ExtensionIO<V,A,O,AB,OB> extensionIO)

OperationIO

public OperationIO(IOContext<V,A,O,AB,OB> context,
 ContentIO<V,A,O,AB,OB> contentIO,
 ExtensionIO<V,A,O,AB,OB> extensionIO)

Method Details

isHidden

public boolean isHidden(org.jboss.jandex.AnnotationTarget target)

read

public org.eclipse.microprofile.openapi.models.Operation read(org.jboss.jandex.AnnotationInstance annotationInstance)

Specified by:

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

readObject

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

Specified by:

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

write

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

Specified by:

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