Top Description Annotations
module org.eclipse.microprofile.openapi

Package org.eclipse.microprofile.openapi.annotations.links

Annotations
@Version:1.1
@ProviderType

Annotations to represent a design-time link for a response and the corresponding parameter to be passed to the linked operation.

Example usage:

 @APIResponse(
     responseCode="201",
     description="review created",
     links = {
         @Link(
             name="Review",
             description="get the review that was added",
             operationId="getReviewById"
     }
 )

Annotation Summary

Modifier and TypeAnnotation and Description
public @interface
Link

The Link object represents a possible design-time link for a response.

public @interface
LinkParameter

Represents a parameter to pass to an operation as specified with operationId or identified via operationRef.