io.swagger.v3.oas.annotations.callbacks

Annotation Type Callback

@Target(value={FIELD,METHOD,PARAMETER,TYPE,ANNOTATION_TYPE})
 @Retention(value=RUNTIME)
 @Repeatable(value=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 and 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 extensions
String	name The friendly name used to refer to this callback
Operation[]	operation The array of operations that will be called out-of band
String	ref A reference to a Callback defined in components Callbacks.

Element Detail

name

public abstract String name

The friendly name used to refer to this callback

Returns:

the name of the callback

Default:

""

callbackUrlExpression

public abstract String callbackUrlExpression

An absolute URL which defines the destination which will be called with the supplied operation definition.

Returns:

the callback URL

Default:

""

operation

public abstract Operation[] operation

The array of operations that will be called out-of band

Returns:

the callback operations

Default:

{}

extensions

public abstract Extension[] extensions

The list of optional extensions

Returns:

an optional array of extensions

Default:

{}

ref

public abstract String ref

A reference to a Callback defined in components Callbacks.

Returns:

the reference

Since:

2.0.3

Default:

""