Annotation Type Operation
-
@Target(METHOD) @Retention(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 Description boolean
deprecated
Allows an operation to be marked as deprecated.java.lang.String
description
A verbose description of the operation behaviour.boolean
hidden
Allows this operation to be marked as hiddenjava.lang.String
operationId
Unique string used to identify the operation.java.lang.String
summary
Provides a brief description of what this operation does.
-
-
-
-
operationId
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:
- ""
-
-
hidden
boolean hidden
Allows this operation to be marked as hidden- Returns:
- whether or not this operation is hidden
- Default:
- false
-
-