Module org.eclipse.microprofile.openapi

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

@Version("1.1") @ProviderType package org.eclipse.microprofile.openapi.annotations.links
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"
          }
      )

Related Packages
Package
Description
org.eclipse.microprofile.openapi.annotations
A set of annotations, many derived from Swagger Core library.
Annotation Types
Class
Description
Link
The Link object represents a possible design-time link for a response.
LinkParameter
Represents a parameter to pass to an operation as specified with operationId or identified via operationRef.