MicroProfile 7.0 · org.eclipse.microprofile.openapi.annotations.Operation

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: whether or not this operation is deprecated deprecated() Allows an operation to be marked as deprecated.
public String	Returns: a description of this operation description() A verbose description of the operation behaviour.
public Extension[]	Returns: array of extensions extensions() List of extensions to be added to the `Operation` model corresponding to the containing annotation.
public boolean	Returns: whether or not this operation is hidden hidden() Allows this operation to be marked as hidden
public String	Returns: the ID of this operation operationId() Unique string used to identify the operation.
public String	Returns: a summary of this operation summary() Provides a brief description of what this operation does.

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

Method Detail

deprecated	back to summary
public boolean deprecated() Allows an operation to be marked as deprecated. Alternatively use the @Deprecated annotation. Consumers SHOULD refrain from usage of a deprecated operation. Returns:boolean whether or not this operation is deprecated

deprecated

back to summary

public boolean deprecated()

Allows an operation to be marked as deprecated. Alternatively use the @Deprecated annotation.

Consumers SHOULD refrain from usage of a deprecated operation.

Returns:boolean: whether or not this operation is deprecated

description	back to summary
public String description() A verbose description of the operation behaviour. CommonMark syntax MAY be used for rich text representation. Returns:String a description of this operation

description

back to summary

public String description()

A verbose description of the operation behaviour. CommonMark syntax MAY be used for rich text representation.

Returns:String: a description of this operation

extensions back to summary

extensions	back to summary
public Extension[] extensions() List of extensions to be added to the `Operation` model corresponding to the containing annotation. Returns:Extension[] array of extensions Since 3.1

public Extension[] extensions()

List of extensions to be added to the Operation model corresponding to the containing annotation.

Returns:Extension[]: array of extensions
Since: 3.1

hidden	back to summary
public boolean hidden() Allows this operation to be marked as hidden Returns:boolean whether or not this operation is hidden

hidden

back to summary

public boolean hidden()

Allows this operation to be marked as hidden

Returns:boolean: whether or not this operation is hidden

operationId	back to summary
public String operationId() Unique string used to identify the operation. The id MUST be unique among all operations described in the API. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions. Returns:String the ID of this operation

operationId

back to summary

public String operationId()

Unique string used to identify the operation. The id MUST be unique among all operations described in the API.

Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.

Returns:String: the ID of this operation

summary	back to summary
public String summary() Provides a brief description of what this operation does. Returns:String a summary of this operation

summary

back to summary

public String summary()

Provides a brief description of what this operation does.

Returns:String: a summary of this operation

public @Interface Operation

Method Summary

Method Detail