io.swagger.oas.annotations

Annotation Type Operation

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

Describes a single API operation on a path.

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 The list of optional extensions
ExternalDocumentation	externalDocs Additional external documentation for this operation.
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.
ApiResponse[]	responses The list of possible responses as they are returned from executing this operation.
SecurityRequirement[]	security A declaration of which security mechanisms can be used for this operation.
Server[]	servers An alternative server array to service this operation.
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.

Returns:

the HTTP method of this operation

Default:

""

tags

public abstract String[] tags

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

Returns:

the list of tags associated with this operation

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.

Returns:

a summary of this operation

Default:

""

description

public abstract String description

A verbose description of the operation.

Returns:

a description of this operation

Default:

""

externalDocs

public abstract ExternalDocumentation externalDocs

Additional external documentation for this operation.

Returns:

additional documentation about this operation

Default:

@io.swagger.oas.annotations.ExternalDocumentation

operationId

public abstract String operationId

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

Returns:

the ID of 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.

Returns:

the list of parameters for this operation

Default:

{}

responses

public abstract ApiResponse[] responses

The list of possible responses as they are returned from executing this operation.

Returns:

the list of responses for this operation

Default:

{}

deprecated

public abstract boolean deprecated

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

Returns:

whether or not this operation is deprecated

Default:

false

security

public abstract SecurityRequirement[] security

A declaration of which security mechanisms can be used for this operation.

Returns:

the array of security requirements for this Operation

Default:

{}

servers

public abstract Server[] servers

An alternative server array to service this operation.

Returns:

the list of servers hosting this operation

Default:

{}

extensions

public abstract Extension[] extensions

The list of optional extensions

Returns:

an optional array of extensions

Default:

{}