Annotation Interface Operation
Describes a single API operation on a path.
- See Also:
-
Optional Element Summary
Modifier and TypeOptional ElementDescriptionboolean
Allows an operation to be marked as deprecated.A verbose description of the operation behaviour.boolean
Allows this operation to be marked as hiddenUnique string used to identify the operation.Provides a brief description of what this operation does.
-
Element Details
-
summary
String summaryProvides a brief description of what this operation does.- Returns:
- a summary of this operation
- Default:
- ""
-
description
String descriptionA verbose description of the operation behaviour. CommonMark syntax MAY be used for rich text representation.- Returns:
- a description of this operation
- Default:
- ""
-
operationId
String operationIdUnique 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
boolean deprecatedAllows 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
-