Annotation Type Callback
-
@Target({FIELD,METHOD,PARAMETER,TYPE,ANNOTATION_TYPE}) @Retention(RUNTIME) @Repeatable(Callbacks.class) @Inherited public @interface Callback
The annotation may be used at method level to add one ore more callbacks to the operation definition.- See Also:
- Callback (OpenAPI specification)
-
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description String
callbackUrlExpression
An absolute URL which defines the destination which will be called with the supplied operation definition.Extension[]
extensions
The list of optional extensionsString
name
The friendly name used to refer to this callbackOperation[]
operation
The array of operations that will be called out-of bandString
ref
A reference to a Callback defined in components Callbacks.
-
-
-
Element Detail
-
name
String name
The friendly name used to refer to this callback- Returns:
- the name of the callback
- Default:
- ""
-
-
-
callbackUrlExpression
String callbackUrlExpression
An absolute URL which defines the destination which will be called with the supplied operation definition.- Returns:
- the callback URL
- Default:
- ""
-
-
-
operation
Operation[] operation
The array of operations that will be called out-of band- Returns:
- the callback operations
- Default:
- {}
-
-
-
extensions
Extension[] extensions
The list of optional extensions- Returns:
- an optional array of extensions
- Default:
- {}
-
-
-
ref
String ref
A reference to a Callback defined in components Callbacks.- Returns:
- the reference
- Since:
- 2.0.3
- Default:
- ""
-
-