io.swagger.oas.annotations

Annotation Type Operation

@Target(value=METHOD)
 @Retention(value=RUNTIME)
 @Inherited
public @interface Operation

Operation Annotation TODO: longer description

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	deprecated allows an operation to be marked as deprecated.
String	description A verbose description of the operation.
Extension[]	extensions
ExternalDocumentation	externalDocs
String	method the HTTP method for this operation
String	operationId The operationId is used by third-party tools to uniquely identify this operation.
Parameter[]	parameters An optional array of parameters which will be added to any automatically detected parameters in the method itself
RequestBody	requestBody
ApiResponse[]	responses
Server[]	servers
String	summary Provides a brief description of this operation.
String[]	tags Tags can be used for logical grouping of operations by resources or any other qualifier.

Element Detail

method

public abstract String method

the HTTP method for this operation

Default:

""

tags

public abstract String[] tags

Tags can be used for logical grouping of operations by resources or any other qualifier.

Default:

""

summary

public abstract String summary

Provides a brief description of this operation. Should be 120 characters or less for proper visibility in Swagger-UI.

Default:

""

description

public abstract String description

A verbose description of the operation.

Default:

""

externalDocs

public abstract ExternalDocumentation externalDocs

Default:

@io.swagger.oas.annotations.ExternalDocumentation

operationId

public abstract String operationId

The operationId is used by third-party tools to uniquely identify this operation.

Default:

""

parameters

public abstract Parameter[] parameters

An optional array of parameters which will be added to any automatically detected parameters in the method itself

Default:

@io.swagger.oas.annotations.Parameter

requestBody

public abstract RequestBody requestBody

Default:

@io.swagger.oas.annotations.parameters.RequestBody

responses

public abstract ApiResponse[] responses

Default:

@io.swagger.oas.annotations.responses.ApiResponse

deprecated

public abstract boolean deprecated

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

Default:

false

servers

public abstract Server[] servers

Default:

@io.swagger.oas.annotations.servers.Server

extensions

public abstract Extension[] extensions

Returns:

an optional array of extensions

Default:

@io.swagger.oas.annotations.extensions.Extension(properties=@io.swagger.oas.annotations.extensions.ExtensionProperty(name="", value=""))