Top Description Annotations
module org.eclipse.microprofile.openapi

Package org.eclipse.microprofile.openapi.annotations.callbacks

Annotations
@Version:1.2
@ProviderType

A set of annotations to represent callback URL or an array of relevant callback URLs that can be invoked for a particular HTTP operation as well as the HTTP operation that will be invoked with the callback.

Example annotation:

@POST
   @Callbacks(
       {@Callback(
           name = "testCallback",
           callbackUrlExpression="http://localhost:9080/oas3-airlines/reviews",
           operations = @CallbackOperation(
               summary = "Get all reviews",
               method = "get",
               responses = @APIResponse(
                   responseCode = "200",
                   description = "successful operation",
                   content = @Content(
                       mediaType = "application/json",
                       schema = @Schema(
                           type = SchemaType.ARRAY,
                           implementation = Review.class
                           )
                       )
                   )
               )
           )
       }
   )

Annotation Summary

Modifier and TypeAnnotation and Description
public @interface
Callback

This object represents a callback URL that will be invoked.

public @interface
CallbackOperation

Describes a single API callback operation.

public @interface
Callbacks

This object represents an array of Callback URLs that can be invoked.