Operation

```
@Target(value=METHOD)
 @Retention(value=RUNTIME)
 @Inherited
public @interface Operation
```
Describes a single API operation on a path.

See Also:

OpenAPI Specification Operation Object

Optional Element Summary

Optional Elements
Modifier and Type	Optional Element and Description
`boolean`	`deprecated` Allows an operation to be marked as deprecated.
`java.lang.String`	`description` A verbose description of the operation behaviour.
`Extension[]`	`extensions` List of extensions to be added to the `Operation` model corresponding to the containing annotation.
`boolean`	`hidden` Allows this operation to be marked as hidden
`java.lang.String`	`operationId` Unique string used to identify the operation.
`java.lang.String`	`summary` Provides a brief description of what this operation does.

- Element Detail
  - summary
```
public abstract java.lang.String summary
```
    Provides a brief description of what this operation does.
    
    Returns:
    
    a summary of this operation
    
    Default:
    
    ""
- - description
```
public abstract java.lang.String description
```
    A verbose description of the operation behaviour. CommonMark syntax MAY be used for rich text representation.
    
    Returns:
    
    a description of this operation
    
    Default:
    
    ""
- - operationId
```
public abstract java.lang.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:
    
    the ID of this operation
    
    Default:
    
    ""
- - deprecated
```
public abstract 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:
    
    whether or not this operation is deprecated
    
    Default:
    
    false
- - hidden
```
public abstract boolean hidden
```
    Allows this operation to be marked as hidden
    
    Returns:
    
    whether or not this operation is hidden
    
    Default:
    
    false
- - extensions
```
public abstract Extension[] extensions
```
    List of extensions to be added to the Operation model corresponding to the containing annotation.
    
    Returns:
    
    array of extensions
    
    Since:
    
    3.1
    
    Default:
    
    {}

Annotation Type Operation

Optional Element Summary

Element Detail

summary

description

operationId

deprecated

hidden

extensions